Product Documentation

FairCom DB API for C

Previous Topic

Next Topic

ctdbDelFieldByName

Delete the field indicated by the field name from a table.

Declaration

CTDBRET ctdbDelFieldByName(CTHANDLE Handle, pTEXT FieldName)

Description

ctdbDelFieldByName() deletes the field indicated by the field name from a table. Note that any fields with higher field numbers than the one you deleted will have one subtracted from their field numbers to fill the gap left by the field you deleted. Use ctdbDelField() to delete a field by number. Use ctdbAddField(), ctdbInsField() and ctdbInsFieldByName() to add fields to a table.

  • Handle [in] the Table handle.
  • FieldName [in] the name of the field to be deleted.

Returns

ctdbDelFieldByName() returns CTDBRET_OK on success or FairCom DB API error code on failure.

See also

ctdbAllocTable(), ctdbAddField(), ctdbInsField(), ctdbInsFieldByName(), ctdbDelField(), ctdbMoveField()

TOCIndex