FairCom DB API for C

ctdbGetCndxIndex

Retrieve the conditional index expression string, given the index number.

Declaration

CTDBRET ctdbGetCndxIndex(CTHANDLE Handle, NINT indexnbr, pTEXT buffer,

NINT bufferlen)

Description

ctdbGetCndxIndex() retrieves the conditional index expression string, given the index number. The conditional expression is added, deleted or updated with ctdbUpdateCndxIndex() or ctdbUpdateCndxIndexByName().

Handle [in] the Table Handle.
indexnbr [in] the index number.
buffer [OUT] pointer to buffer to receive the conditional expression.
bufferlen [IN] size in bytes of buffer. Maybe retrieved with ctdbGetCndxIndexLength() or ctdbGetCndxIndexLengthByName().

Returns

ctdbGetCndxIndex() returns CTDBRET_OK on success, or FairCom DB API error on failure.