tibasKeyDef_GetIndexType()

Returns the index type for a specified primary key

Declaration

tibas_status tibasKeyDef_GetIndexType(
    tibasKeyDef keyDef,
    tibas_indexType* indexType)

Parameters

Parameter Description
keyDef Specifies the key definition for the key whose index type is to be retrieved.
tibas_indexType Returns the index type currently set for the key.

Remarks

Use the tibasKeyDef_GetIndexType() function to return the index type for a specified primary key.

The tibas_indexType parameter returns the index type, which can be one of the following:

TIBAS_INDEX_HASH
Specifies that indexing is done by using a hash table.
TIBAS_INDEX_TREE
Specifies that indexing is done using a tree.

See Also

tibasKeyDef_SetIndexType()