You are here: C++ API > Classes > dtsViewerInfo Structure > dtsViewerInfo::getInfoByIndex Data Member
Close
dtSearch Text Retrieval Engine Programmer's Reference
Contents|Index|Home
Previous|Up|Next
dtsViewerInfo::getInfoByIndex Data Member
dtsViewerInfo Structure
Syntax
C++
int (* getInfoByIndex)(dtsViewerHandle handle, long index, dtsContainerItemInfo& info);

dtsViewerInfo Structure

Parameters
Description
handle
Handle identifying the container
index
An integer identifying this item in the container.
info
Identifies the item to extract
To support 64-bit containers without changing the function signature, the following convention is used: (1) A container file parser that uses 64-bit values should set the flag viIs64bit in its dtsViewerInfo.flags. (2) For 64-bit bit containers, If index is 0 and info.getIndexInContainer() is non-zero, the container parser should use the 64-bit value returned by info.getIndexInContainer() to locate the item.

0 on success, non-zero on failure.

Pointer to function that will get information about an item in the container, identified by its numerical index. (See dtsContainerItemInfo.indexInContainer.)