Skip to main content

PxIORecordRead

Description

Reads the record associated with the given record number from the specified file

Format

int PxIORecordRead(PxIOFileHandle handle, RecordInfo *record, int recordNumber, int keyNumber, PxIOReadType readType);

Where:

handle

The handle of an open file

record

Pointer to a RecordInfo structure. When the function returns, this structure will contain a pointer to the requested record's contents and the record's size.

recordNumber

The record number of the record to read

keyNumber

The key sequence number of which the record number is a member. If the value passed is -1, then the key sequence will be based on the one previously used with the file handle. The initial key sequence of a file will be the primary one. Ignored for non-keyed files.

readType

Determines the behavior of the function with respect to other users. See Appendix C for more information on this option.

Return Value

If the function succeeds, a value of PXIO_SUCCESS_STATUS is returned; otherwise, an error value is returned. More information on the nature of the error can be found by calling PxIOGetError.