c-treeDB API API for C

ctdbGetCndxIndexByName

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

Declaration

CTDBRET ctdbGetCndxIndexByName(CTHANDLE Handle, pTEXT indexname,

pTEXT buffer, NINT bufferlen)

Description

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

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

Returns

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

See also

ctdbGetCndxIndex(), ctdbUpdateCndxIndex(), ctdbUpdateCndxIndexByName(), ctdbGetCndxIndexLength(), ctdbGetCndxIndexLengthByName()