DbiSetToRecordNo

C syntax

DBIResult DBIFN DbiSetToRecordNo (hCursor, iRecNo);

Delphi syntax

function DbiSetToRecordNo (hCursor: hDBICur; iRecNo: Longint): DBIResult stdcall;

Description

DbiSetToRecordNo positions the cursor to the given physical record number.

Parameters

hCursor Type: hDBICur (Input)
Specifies the cursor handle.

iRecNo Type: UINT32 (Input)
Specifies the physical record number.

Usage

This function is currently valid only with dBASE and FoxPro tables. The physical record number can be retrieved from the iPhyRecNum field of the RECProps structure in calls to DbiGetRecord, DbiGetNextRecord, DbiGetPriorRecord, or DbiGetRelativeRecord.

If the given record number is beyond the valid range for the cursor, the cursor is set to the beginning or end of the file (BOF/EOF).

DbiResult	Meaning
DBIERR_NONE	The cursor was successfully set to the record specified by iRecNo.
DBIERR_INVALIDHNDL	The specified cursor handle is invalid or NULL.
DBIERR_BOF	The specified record number is zero.
DBIERR_EOF	The specified record number is greater than the number of records in the table.
DBIERR_NOTSUPPORTED	This function is not supported for Paradox and SQL tables.