[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'DB' (#fcl)

TDataSet.CompareBookmarks

Compare two bookmarks

Declaration

Source position: db.pas line 1681

public function TDataSet.CompareBookmarks(

  Bookmark1: TBookMark;

  Bookmark2: TBookMark

):LongInt; virtual;

Arguments

Bookmark1

  

First bookmark

Bookmark2

  

Second bookmark.

Function result

result of the compare operation

Description

CompareBookmarks can be used to compare the relative positions of 2 bookmarks. It returns a negative value if Bookmark1 is located before Bookmark2, zero if they refer to the same record, and a positive value if the second bookmark appears before the first bookmark. This function must be overridden by descendent classes of TDataset. The implementation in TDataset always returns zero.

Errors

No checks are performed on the validity of the bookmarks.

See also

TDataset.BookmarkValid

  

Test whether ABookMark is a valid bookmark.

TDataset.GetBookmark

  

Get a bookmark pointer (deprecated)

TDataset.SetBookmark


Documentation generated on: May 14 2021