c-treeDB API API for C

ctdbRecordSetOff

Disable and free an existing record set.

Declaration

CTDBRET ctdbRecordSetOff(CTHANDLE Handle)

Description

ctdbRecordSetOff() disables and free an existing record set. To enable a new record set, use ctdbRecordSetOn().

Handle [in] the record handle.

Returns

ctdbRecordSetOff() returns CTDBRET_OK if successful, or the c-tree error code on failure. The possible errors associated with ctdbRecordSetOff() are:

CTDBRET_NOTRECORD (4024): Invalid Record Handle

Example

ctdbRecordSetOn(pRec, 5);

ctdbSetDefaultIndexByName(pRec, "last name");

ctdbSetFieldAsString(pRec, 0, "silva");

ctdbFirstRecord(pRec);

ctdbRecordSetOff(pRec);