FairCom DB API for C

ctdbGetDefaultIndex

Return the current default index.

Declaration

NINT ctdbGetDefaultIndex(CTHANDLE Handle)

Description

ctdbGetDefaultIndex() returns the current default index number. When the record handle is initialized for the first time, the default index is set to zero. To retrieve the index name, use ctdbGetDefaultIndexName(). Use ctdbSetDefaultIndex() to set the default index for the table.

• Handle [in] the record handle.

Returns

ctdbGetDefaultIndex() returns the table default index, or -1 on error.

• CTDB_DATA_IDXNO: indicates a physical data table traversal without using any indexes.

See also

ctdbAllocRecord(), ctdbGetTableIndexCount(), ctdbSetDefaultIndex(), ctdbGetDefaultIndexName()