Product Documentation

c-treeDB API API for C

Previous Topic

Next Topic

ctdbGetIdentityFieldDetails

Declaration

pTEXT ctdbGetIdentityFieldDetails(CTHANDLE Handle, pLONG8 seed, pLONG8 increment)

Description

Returns the name, seed, and increment values of the Identity field.

Return Values

ctdbGetIdentityFieldDetails() returns the Identity Field name on success or NULL on failure. Call ctdbGetError() to verify if there was an actual error or if there is no identity field defined.

Example

LONG startval, incval;

TEXT astring[80];
pTEXT idcol = astring;


idcol = ctdbGetIdentityFieldDetails(myTable, &startval, &incval)

if (idcol)

printf("Identity column %s, is assigned a start value of %d and increment of %d\n",

startval, incval);

else

printf("Error in retrieving ID details, %d\n",

ctdbGetError() );

See Also

ctdbGetLastIdentity(). ctdbSetIdentityField()

TOCIndex