FairCom DB API for C

ctdbGetIndexKSeg

Retrieves the index current extended key segment definition.

DECLARATION

CTDBRET ctdbGetIndexKSeg(CTHANDLE Handle, pctKSEGDEF pKSeg);

DESCRIPTION

ctdbGetIndexKSeg() retrieves the current index-wide extended key segment definition. Handle must be a FairCom DB API index handle and pKSeg is a pointer to an extended key segment definition structure which will receive the definition.

RETURN

Value	Symbolic Constant	Explanation
0	CTDBRET_OK	No error occurred.
4096	CTDBRET_NOTFOUND	Not found.

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

EXAMPLE

ctKSEGDEF kseg;

if ((eRet = ctdbGetIndexKSeg(hTable, &kseg)) != CTDBRET_OK)

printf("ctdbGetIndexKSeg failed with error %d\n", eRet);