4.3.93 ctdbFirstRecord

---

Get the first record on a table

Declaration

CTDBRET ctdbFirstRecord(CTHANDLE Handle)

Description

ctdbFirstRecord retrieves the first record on a table. The ordering of the records is done through one of the indices that was defined during the table creation. In order to define which index is sorting the table, use ctdbSetDefaultIndex. Initially, the default index is the first defined index during the table creation.

Handle [in] the record handle.

If sets are enabled by ctdbRecordSetOn, ctdbFirstRecord will retrieve the first record in the set. Use ctdbNextRecord to retrieve the next record on a table, ctdbPrevRecord to retrieve the previous record on a table, and ctdbLastRecord to retrieve the last record on a table. Use ctdbFindRecord to find a specific record on a table.

Returns

ctdbFirstRecord returns CTDBRET_OK on success, or c-treeDB C API error on failure.

See also

ctdbAllocRecord, ctdbNextRecord, ctdbPrevRecord, ctdbLastRecord, ctdbFindRecord, ctdbRecordSetOn, ctdbSetDefaultIndex