Data.DB.TDataSet.GetBookmark
Delphi
function GetBookmark: TBookmark; virtual;
C++
virtual System::DynamicArray<System::Byte> __fastcall GetBookmark();
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.DB.pas Data.DB.hpp |
Data.DB | TDataSet |
Description
Allocates a bookmark for the active record in the dataset.
Call GetBookmark to establish a bookmark for the active record in the dataset. Establishing a bookmark for a record enables a dataset to return to that record at any time while the bookmark exists.
GetBookmark requires that a variable for the bookmark (for Delphi, of type TBookmark) already be declared in the application. Use GetBookmark to assign a value to the variable. This value can then be referenced by subsequent calls to GotoBookmark.
Note: GetBookmark relies on a protected method to obtain the bookmark value. TDataSet descendants implement this method to provide their own type of bookmark support. Unidirectional datasets do not support bookmarks, and so do not return a meaningful value.
See Also