Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbSetIndexName

Change the index name.

Declaration

CTDBRET ctdbSetIndexName(CTHANDLE Handle, pTEXT IndexName)

Description

ctdbSetIndexName() changes the index name. The index name can only be changed before the table is created. ctdbSetIndexName() will fail if the table is active.

  • Handle [in] the index handle.
  • IndexName [in] the new index name.

Returns

ctdbSetIndexName() returns CTDBRET_OK on success, or c-treeDB API C API error on failure.

See also

ctdbCreateTable(), ctdbAddIndex()

TOCIndex