TMemDataset.GetBookmarkFlag function
Gets BookmarkFlag data from the specified record buffer.
Declaration
function GetBookmarkFlag(Buffer: TRecordBuffer): TBookmarkFlag
; overrideArguments
Buffer | Record buffer with BookmarkFlag data. |
Function result
BookmarkFlag for the specified record buffer.
Description
GetBookmarkFlag is used to get BookmarkFlag data from the specified record buffer. Bookmark flags are an internal mechanism which provide status information for the record, such as:
- bfCurrent
- Record is currently selected in the dataset
- bfBOF
- Record is at the Beginning-of-File
- bfEOF
- Record is at the End-of-File
- bfInserted
- Record has been inserted
GetBookmarkFlag examines the byte values in Buffer starting at the offset for record information. The values are cast to a PRecInfo record type which provides access to the Bookmark and BookmarkFlags for the record. The return value contains the TBookmarkFlag in the byte values.
GetBookmarkFlag implements the virtual method from the ancestor class. It is called from the BookmarkAvailable and SetCurrentRecord methods.
See also
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.
