Datasnap.DBClient.TCustomClientDataSet.GetBookmarkFlag

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: protected
Source:
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Unit: Datasnap.DBClient
Parent: TCustomClientDataSet

Delphi

function GetBookmarkFlag(Buffer: TRecBuf): TBookmarkFlag; overload; override;
function GetBookmarkFlag(Buffer: TRecordBuffer): TBookmarkFlag; overload; override; deprecated 'Use overloaded method instead';

C++

virtual Data::Db::TBookmarkFlag __fastcall GetBookmarkFlag(Data::Db::TRecBuf Buffer)/* overload */;
virtual Data::Db::TBookmarkFlag __fastcall GetBookmarkFlag _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (Data::Db::TRecordBuffer Buffer)/* overload */;

Description

Gets the bookmark flag for the record buffer given by the parameter.

Datasnap.DBClient.TCustomClientDataSet.GetBookmarkFlag inherits from Data.DB.TDataSet.GetBookmarkFlag. All content below this line refers to Data.DB.TDataSet.GetBookmarkFlag.

Gets the bookmark flag for the record buffer given by the parameter.

GetBookmarkFlag is used to get the bookmark flag for the Buffer record buffer. The method returns a TBookmarkFlag value.

The method is virtual. Every TDataSet descendant must implement it in a specific way. Note that a record buffer stores the data of the record, the bookmark, and the bookmark flags.

Note: Unidirectional datasets do not use bookmarks.

See Also