c-treeDB API API for C

ctdbGetFieldProperties

Retrieve field properties such as name, type, and length, given a field handle.

Declaration

CTDBRET ctdbGetFieldProperties(CTHANDLE Handle, ppTEXT FieldName,

pCTDBTYPE pType, pVRLEN pLength)

Description

ctdbGetFieldProperties() retrieves field properties such as name, type, and length, given a field handle. These values come from the table definition. Use ctdbSetFieldProperties() to set the field properties.

Handle [in] the Field Handle.
FieldName [out] the field name.
pType [out] the field type.
pLength [out] the field length.

Returns

ctdbGetFieldProperties() returns CTDBRET_OK on success, or a c-treeDB API error code on failure