c-treeDB API for C++ - Developers Guide

CTTable::GetCndxIndexByName

Syntax

#ifdef PROTOTYPE

CTDBRET ctdbDECL ctdbGetCndxIndexByName(CTHANDLE Handle, pTEXT indexname,

pTEXT buffer, NINT bufferlen)

#else

CTDBRET ctdbDECL ctdbGetCndxIndexByName(Handle, indexname, buffer, bufferlen)

CTHANDLE Handle;

pTEXT indexname;

pTEXT buffer;

NINT bufferlen;

#endif

Parameters

• handle [in] table handle
• indexname [in] index name
• buffer [out] pointer to buffer to receive the conditional expression
• bufferlen [in] size in bytes of buffer

Description

Retrieves the conditional index expression string, given the index name.

Return

Return CTDBRET_OK on success

See also

GetCndxIndex(), GetCndxIndexLength(), GetCndxIndexLengthByName()