int pblIsamGet

( pblIsamFile_t* isamfile, int which, int index,
  void* okey )

get the key and keylen of a record

Documentation

get the key and keylen of a record

parameter which specifies which record to get relative to the search key specified by index. the following values for which are possible

PBLTHIS - get key and keylen of current record
PBLNEXT - get key and keylen of next record
PBLPREV - get key and keylen of previous record
PBLFIRST - get key and keylen of first record
PBLLAST - get key and keylen of last record

parameter index specifies which of the keys to get, the pseudo index value -1 can be used in order to access the file sequentially in the order the records were inserted. okey is not set in this case, a key length of 0 is returned in case the call went OK.

RESTRICTIONS:
- the out parameter okey must point to a memory area that is big enough to hold any possible key, i.e 255 bytes

Parameters:

isamfile - ISAM file to read in
which - mode to use for read
index - index of key to use for read
okey - buffer for result key

Returns:

int rc >= 0:

• call went OK, the value returned is the length of the key of the record found,
• the key of the record is copied to okey,
• the current record of the file is set to the record found

int rc < 0:

• some error occurred, see pbl_errno

Alphabetic index