DbiSetToSeqNo

C syntax

DBIResult DBIFN DbiSetToSeqNo (hCursor, iSeqNo);

Delphi syntax

function DbiSetToSeqNo (hCursor: hDBICur; iSeqNo: Longint): DBIResult stdcall;

Description

DbiSetToSeqNo positions the cursor to the specified sequence number of a table. Currently supported by Paradox only.

Parameters

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

iSeqNo Type: UINT32 (Input)
Specifies the logical record number.

Usage

This function is currently valid only with Paradox tables. The sequence number can be retrieved by calling DbiGetSeqNo or from the iSeqNo field of the RECProps structure in calls to DbiGetRecord, DbiGetNextRecord, DbiGetPriorRecord, or DbiGetRelativeRecord.

A sequence number is the position of a record in the result set associated with hCursor. If the given sequence number is beyond the valid sequence number for the cursor, the cursor is set to the beginning or end of the file (BOF/EOF). For example, if the table is empty, this function leaves the cursor positioned at BOF and returns DBIERR_BOF. If the table is not empty and the user attempts to position the cursor beyond a valid sequence number, the cursor is set to EOF, and DBIERR_EOF is returned.

Note:

The sequence number for a given record is not stable. If a record is inserted or deleted before the given index order, the sequence number for the record changes.

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