CurrentLowLevelKey

Get a key from the current low-level key buffer.

Short Name

GETCURKL()

Type

Low level function

Declaration

pVOID CurrentLowLevelKey(COUNT keyno, pVOID idxval);

Description

CurrentLowLevelKey() copies the current low-level key buffer for index file keyno into the buffer pointed to by idxval.

Return

CurrentLowLevelKey() returns idxval. A NULL signifies an error - check uerr_cod. See “c-tree Plus Error Codes” in the c-tree Plus Programmer’s Reference Guide for a complete listing of valid c-tree Plus error values.

Example

COUNT keyfil;

TEXT  keybuf[50];


if (CurrentLowLevelKey(keyfil,&keybuf) == NULL)

   printf("\nError %d retrieving key.", uerr_cod);

Limitations

No check is made to determine if idxval points to a region sufficiently large to accept the key. If the area is too small, either code or data will be clobbered. Use GetCtFileInfo() to obtain the key length.