tibasIndexDefList_Get()

Returns the Index definition for an element at a specified position in an IndexDefList for a specified IndexDef element.

Declaration

tibas_status tibasIndexDefList_Get(
    tibasIndexDefList indexDefList,
    tibasIndexDef*    indexDef,
    tibas_int         index)

Parameters

Parameter Description
indexDefList Specify the IndexDefList to search.
indexDef Returns the IndexDef at the specified index position.
index Specify an index value. If the index value you specify is above the maximum number of entries in the list, the function returns an error.

Remarks

Use the tibasIndexDefList_Get() function to return the indexDef that is at a specified index position in an indexDefList.

The value returned by the tibasIndexDefList_Size() function provides the number of entries in the list.