Item Method (COM-based API)

This method provides access to a single element of the collection.

Visual Basic Syntax

Method Item(
   index As Long
) As ObjectType

C++ Syntax

HRESULT Item(
    long index,
    InterfaceType** pVal
);

Parameters

index

[in] This variable contains the index of the element that is accessed via this method. It must be in the range from 0 to the Number of elements - 1, where the number of elements may be received from the Count property of the same collection.

objectType

[out] The type of objects in the collection. For example, for the InputFiles collection this type is InputFile.

pVal

[out] A variable of type InterfaceType* that receives a pointer to the interface of the collection element. pVal must not be NULL. *pVal is guaranteed to be non-NULL after a successful method call. InterfaceType is the type of the interface of the objects forming the collection.

Return Values

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

Remarks

The following collections supports this method: StringsCollection, OutputFormatSettingsCollection, InputFiles, OutputDocuments, Workflows, DocumentInfoItems, DocumentAttributes, DocumentTypes, IndexingFields.

See also

Working with Collections.

See samples: Samples.

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.