FairCom ISAM for C

GetVRecord

Read the variable-length record with a key equal to target.

Short Name

EQLVREC()

Type

ISAM function

Declaration

COUNT GetVRecord(COUNT keyno, pVOID target, pVOID recptr, pVRLEN plen)

Description

GetVRecord() is the same as its fixed-length counterpart, GetRecord(), except one argument has been added: plen.

plen acts as both an input and output parameter:

On input, plen contains the length of the output buffer.
On output, the contents of plen is the actual data-record length. If the length of the output buffer is less than the actual record length, a partial read is performed. If an error occurs, plen is unspecified.

Read the function description for GetRecord() for additional important information.

Return

Value	Symbolic Constant	Explanation
0	NO_ERROR	Successful retrieval of current ISAM record.
633	NPLN_ERR	recptr is NULL. No data file read performed.

See c-tree Error Codes for a complete listing of valid c-tree error values.