Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbGetFieldLength

Retrieve the field length (the defined size of the field).

Declaration

VRLEN ctdbGetFieldLength(CTHANDLE Handle)

Description

ctdbGetFieldLength() retrieves the field length, given a field handle. This is the defined size of the field in the table definition. To get this information given a record handle and a field number, use ctdbGetFieldSize(). To get the actual number of bytes being consumed by the data in a single field, in a single record (row) from a table, use ctdbGetFieldDataLength().

  • Handle [in] the Field Handle. This must be a field handle, and not any other handle type.

Returns

ctdbGetFieldLength() returns the field length, or -1 on failure

See also

ctdbAllocField(), ctdbGetFieldNumber(), ctdbGetFieldName(), ctdbGetFieldType(), ctdbGetFieldLength(), ctdbSetFieldLength()

TOCIndex