CreateNewField Method of IndexingFields Object (COM-based API)

This method creates a new IndexingField object of specified type and returns a reference to it.

Visual Basic Syntax

Method CreateNewField(
   Type As AttributeTypeEnum,
   IsRequired As Boolean,
   IsVisible As Boolean,
   IsReadOnly As Boolean,
   name As String
) As IndexingField

C++ Syntax

HRESULT CreateNewField(
    AttributeTypeEnum Type,
    VARIANT_BOOL IsRequired,
    VARIANT_BOOL IsVisible,
    VARIANT_BOOL IsReadOnly,
    BSTR Name,
    IIndexingField** item
);

Parameters

Type

[in] This parameter specifies the type of indexing field. See the AttributeTypeEnum description for the supported fields.

IsRequired

[in] This parameter specifies if indexing field is required.

IsVisible

[in] This parameter specifies if indexing field is visible.

IsReadOnly

[in] This parameter specifies if indexing field is read only.

Name

[in] This parameter contains the name of new indexing field.

item

[out] A pointer to the IndexingField object.

Return Values

This method has no specific return values. It returns standard return values of ABBYY FineReader Server COM-based API functions.

See also

Working with Collections.

26.03.2024 13:49:49

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.