Sign in Join
FPDoc Onlineexperiment

TCustomBufDataset.GetBookmarkFlag function

Member of TCustomBufDatasetprotectedIn unit BufDataset

Gets Bookmark flag data from the specified record buffer.

Declaration

pascal
function GetBookmarkFlag(Buffer: TRecordBuffer): TBookmarkFlag
 ; override

Arguments

Buffer

Record buffer with the bookmark flag value.

Function result

Bookmark flag data copied from the record buffer.

Description

GetBookmarkFlag is an overridden TBookmarkFlag function used to get Bookmark flag data from the record buffer specified in Buffer. GetBookmarkFlag re-implements the method defined in the ancestor class. GetBookmarkFlag casts the value in Buffer to PBufBookmark, and uses its BookmarkFlag property as the return value for the method.

The return value is set to bfCurrent when record data is copied to the current record. It may contain the value bfBOF or bfEOF when the record is at the beginning or end of the current index order. The value bfInserted indicates the record was appended or inserted.

GetBookmarkFlag is used in the implementation of the BookmarkAvailable and SetCurrentRecord methods.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.