Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbGetIndexFilename

Retrieves the current index file name associated with an index.

Declaration

pTEXT ctdbGetIndexFilename(CTHANDLE Handle);

  • Handle is an index handle returned by ctdbAddIndex() or ctdbGetIndex() calls.

Description

ctdbGetIndexFilename() may return NULL indicating that the index is a member of an index superfile.

Return

ctdbGetIndexFilename() returns the physical filename of the index.

See Appendix A "c-tree Plus Error Codes" in c-tree Plus Programmer's Reference Guide for a complete listing of valid c-tree Plus error values.

See also

ctdbSetIndexFilename(), ctdbAddIndex(), ctdbGetIndex()

TOCIndex