DbiCompareBookMarks

C syntax

DBIResult DBIFN DbiCompareBookMarks (hCur, pBookMark1, pBookMark2, pCmpBkmkResult);

Delphi syntax

function DbiCompareBookMarks (hCur: hDBICur; pBookMark1: Pointer; pBookMark2: Pointer; var CmpBkmkResult: Word): DBIResult stdcall;

Description

DbiCompareBookMarks compares the relative positions of two bookmarks associated with the cursor.

Parameters

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

pBookMark1 Type: pBYTE (Input)
Specifies the pointer to the first bookmark.

pBookMark2 Type: pBYTE (Input)
Specifies the pointer to the second bookmark.

pCmpBkmkResult Type: pCMPBkMkRslt (Output)
Pointer to the client variable that receives the comparison result.

Usage

Both bookmarks must be placed on cursors opened on the same table with the same order.

Note:

Comparing bookmarks from cursors with different orders or that are unstable can lead to unpredictable results.

Prerequisites

Valid bookmarks must have been obtained with DbiGetBookMark.

DbiResult	Meaning
DBIERR_NONE	Bookmarks were compared successfully.
DBIERR_INVALIDHNDL	The specified cursor is invalid or NULL.
DBIERR_INVALIDPARAM	At least one of the following parameters is NULL: pBookMark1, pBookMark2.
DBIERR_INVALIDBOOKMARK	Bookmarks are incompatible or corrupt.