c-treeDB API API for C

ctdbAddToFieldMask

Add the field to field Mask.

Declaration

CTDBRET ctdbDECL ctdbAddToFieldMask(CTHANDLE Handle, NINT FieldNbr)

Description

• Handle [IN] - Record handle
• FieldNbr [IN] - Field number of the field to be add to the list of fields that are exposed

On the first call activates the field Mask. When the field Mask is active only fields in the field Mask can be retrieved, not record write is allowed. It optimizes the client/server communication by reducing the information retrieved from the server.

Returns

Returns CTDBRET_OK if successful, or the c-tree error code on failure.