long pblKfGetRel

( pblKeyFile_t* k, long relindex, void* okey,
  size_t* okeylen )

Set current record to a record with a relative position index.

Documentation

Set current record to a record with a relative position index.

This function is only to be used through the macro functions:

pblKfThis( k, okey, okeylen ) read key of current record
pblKfNext( k, okey, okeylen ) read key of next record
pblKfPrev( k, okey, okeylen ) read key of previous record

Parameters:

k - key file to position in
relindex - index relative to current record
okey - buffer for result key
okeylen - length of the result key after return

Returns:

long rc >= 0:

• call went ok, the value returned is the length of the data of the record found,
• the length of the key of the record is set in the out parameter okeylen,
• the key of the record is copied to okey,
• the current record of the file is set to the record found

long rc < 0:

• some error occured, see pbl_errno

Alphabetic index