Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbHasDelField

Tests for the presence of the internal delete flag.

Declaration

CTBOOL ctdbDECL ctdbHasDelField(CTHANDLE Handle);

Description

ctdbHasDelField() tests for the presence of the internal delete flag, $DELFLD$, field in a table. $DELFLD$ is a hidden field that c-treeDB API automatically creates as the first field in the record buffer. $DELFLD$ is defined as a 4-byte CT_ARRAY field (to ensure proper alignment of subsequent fields) and its only purpose is to keep a place at the beginning of the record to hold the c-tree delete record flag byte when a record is deleted. This field is handled internally by c-treeDB API and should never be modified by the user.

ctdbHasDelField() receives a table handle as parameter and returns YES if the table was created with a $DELFLD$ field. ctdbHasDelField() returns NO if the table was not created with a $DELFLD$ field.

Return

Symbolic Constant

Explanation

YES

$DELFLD$ in table.

NO

$DELFLD$ not in table.

TOCIndex