Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbGetFieldDefaultTimeType

Retrieves the default value time type.

Declaration

CTTIME_TYPE ctdbGetFieldDefaultTimeType(CTHANDLE Handle);

Description

Retrieves the default value time type used when converting strings to dates. Handle must be a c-treeDB API field handle.

Return

Value

Symbolic Constant

Explanation

1

CTTIME_HMSP

Time format is hh:mm:ss am|pm

2

CTTIME_HMP

Time format is hh:mm am|pm

3

CTTIME_HMS

Time format is hh:mm:ss (24 hour)

4

CTTIME_HM

Time format is hh:mm (24 hour)

5

CTTIME_MIL

Time format is hhmm (military)

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

Example

/* check the default time type */

hField = ctdbGetField(hTable, 5);

if (ctdbGetFieldDefaultTimeType(hField) != CTDBRET_OK)

printf("Default time type is not OK\n");

See Also

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

TOCIndex