Product Documentation

FairCom DB API for C

Previous Topic

Next Topic

ctdbGetIndexKeyType

Retrieve the key type for this index.

Declaration

CTDBKEY ctdbGetIndexKeyType(CTHANDLE Handle)

Description

ctdbGetIndexKeyType() retrieves the key type for this index. Use ctdbAddIndex() to add an index to a table.

  • Handle [in] the index handle.

Use ctdbSetIndexKeyType() to set the Index key type.

Returns

ctdbGetIndexKeyType() returns the key type, or CTINDEX_ERROR on error. Allowed key types are listed in FairCom DB API definitions.

See also

ctdbAllocIndex(), ctdbAddIndex(), ctdbSetIndexKeyType()

TOCIndex