Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbClearFieldDefaultValue

Clears the default value associated with a c-treeDB API field.

DECLARATION

CTDBRET ctdbClearFieldDefaultValue(CTHANDLE Handle)

DESCRIPTION

Clears the default value associated with a field. The default date and time types are also reset to their default values of CTDATE_MDCY and CTTIME_HMS respectively. Handle must be a field handle.

RETURN

Value

Symbolic Constant

Explanation

0

NO_ERROR

No error occurred.

See Appendix A for a complete listing of valid c-tree Plus error values.

EXAMPLE

/* clear the default field value */

hField = ctdbGetField(hTable, 5);

if (hField)

if (ctdbClearField(hField) != CTDBRET_OK)

printf("ctdbClearField failed\n");

SEE ALSO

ctdbSetFieldDefaultValue(), ctdbGetFieldDefaultValue(), ctdbIsFieldDefaultValueSet(),
ctdbClearAllFieldDefaultValue(), ctdbSetFieldDefaultDateTimeType(),
ctdbGetFieldDefaultDateType(), ctdbGetFieldDefaultTimeType()

TOCIndex