Product Documentation

FairCom DB API for C

Previous Topic

Next Topic

ctdbUpdateCndxIndexByName

Add, change or delete the conditional expression associated with an index, given by name.

Declaration

CTDBRET ctdbUpdateCndxIndexByName(CTHANDLE Handle, pTEXT indexname,

pTEXT cndexpr)

Description

ctdbUpdateCndxIndexByName() adds, changes or deletes the conditional expression associated with an index, given by name. After the conditional expression is successfully associated with the index, the index data is automatically rebuilt. To retrieve the conditional expression, use ctdbGetCndxIndex() or ctdbGetCndxIndexByName().

  • Handle [in] the Table Handle.
  • indexname [in] the index name.
  • cndexpr [in] string containing the conditional expression.

Returns

ctdbUpdateCndxIndexByName() returns CTDBRET_OK on success, or FairCom DB API C API error code on failure.

See also

ctdbUpdateCndxIndex(), ctdbGetCndxIndex(), ctdbGetCndxIndexByName(), ctdbGetCndxIndexLength(), ctdbGetCndxIndexLengthByName()

TOCIndex