FairCom ISAM for C

FirstVRecord

Read the first variable-length data record.

Short Name

FRSVREC()

Type

ISAM function

Declaration

COUNT FirstVRecord(FILNO filno, pVOID recptr, pVRLEN plen)

Description

In V12 the file number typedef was formally changed from COUNT, a two-byte value to FILNO, a four-byte value. Refer to this link for compatibility details. Four Byte File Numbering

FirstVRecord() is identical to it’s fixed-length counterpart, FirstRecord(), except that it reads the first variable-length data record in the data file. If successful, this record becomes the current ISAM record for the associated data file.

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 FirstRecord() for additional important information.

Return

Value	Symbolic Constant	Explanation
0	NO_ERROR	Successful retrieval of current ISAM record.
633	NPLN_ERR	plen is NULL.
634	NLEN_ERR	plen is negative on input.

See FairCom DB Error Codes for a complete listing of valid FairCom DB error values.