DbiGetSeqNo

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiGetSeqNo

Return to chapter overview

C syntax

DBIResult DBIFN DbiGetSeqNo (hCursor, piSeqNo);

Delphi syntax

function DbiGetSeqNo (hCursor: hDBICur; var iSeqNo: Longint): DBIResult stdcall;

Description

DbiGetSeqNo retrieves the sequence number of the current record in the table associated with the cursor.

Parameters

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

piSeqNo                Type: pUINT32                (Output)
Pointer to the client variable that receives the logical sequence number of the current record in the table associated with hCursor.

Usage

Paradox: This function is supported for all Paradox tables.

SQL: This function is not supported by SQL drivers.

dBASE: This function is not supported by the dBASE driver.

Access: This function is not supported by the Access driver.

Cached updates: This function is not supported with cached updates, since cached updates use an in-memory table.

Prerequisites

The cursor should be positioned on a record.

Completion state

The sequence number is the relative position of a record with respect to the beginning of the file. A sequence number for a given record therefore depends on the current index in use. An active range also affects the sequence numbers, the sequence number is relative to the beginning of the range. Filters do not affect sequence numbers, so there might seem to be gaps in the sequence numbers.

DbiResult

Meaning

DBIERR_NOTSUPPORTED

This call is not supported for the given table.

DBIERR_NONE

The sequence number was returned successfully.

DBIERR_BOF

The cursor must be positioned on a record; it is positioned at the beginning of the file.

DBIERR_EOF

The cursor must be positioned on a record; it is positioned at the end of the file.

DBIERR_KEYORRECDELETED

The cursor is positioned on a deleted record.

DBIERR_NOCURRREC

No record is current.

See also

DbiSetToSeqNo, DbiGetCursorProps