IBX.IBCustomDataSet.TIBCustomDataSet.CompareBookmarks

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CompareBookmarks(Bookmark1, Bookmark2: TBookmark): Integer; override;

C++

virtual int __fastcall CompareBookmarks(System::DynamicArray<System::Byte> Bookmark1, System::DynamicArray<System::Byte> Bookmark2);

Properties

Type Visibility Source Unit Parent
function public
IBX.IBCustomDataSet.pas
IBX.IBCustomDataSet.hpp
IBX.IBCustomDataSet TIBCustomDataSet

Description

Compares two bookmarks.

Call CompareBookmarks to compare one bookmark to another. CompareBookmarks returns an integer value indicating the difference between the two bookmarks. CompareBookmarks returns a 0 (zero) if the two bookmarks are the same, a -1 (negative one) if bookmark one is less than bookmark two, or a 1 (positive one) if bookmark one is greater than bookmark two. CompareBookmarks also returns a zero if one of the two bookmarks is nil (Delphi) or NULL (C++).

Bookmark1 and Bookmark2 are the two TBookmark values to compare.