TDANativeDatabaseAccess_Dataset
Overview
The TDANativeDatabaseAccess_Dataset class implements the IDANativeDatabaseAccess interface.
Location
- Unit: uDANativeDatabaseAccessSupport.pas
- Ancestry: TInterfacedObject | TDANativeDatabaseAccess_Dataset
constructor Create
Creates a new instance.
constructor Create(aDADataset: TDAESQLCommand)
Parameters:
- aDADataset: owner
CanFreeNativeFieldData protected
Specifies that given field can destroy pointer returned in GetNativeFieldData method
function CanFreeNativeFieldData: Boolean
CanUseNativeFieldData protected
Specifies that given field can return data in GetNativeFieldData method
function CanUseNativeFieldData(Index: Integer): Boolean
Parameters:
- Index: Required field index
ClearFieldDefs protected
Clears field definitions
procedure ClearFieldDefs
ControlsDisabled protected
Indicates whether data-aware controls update their display to reflect changes to the dataset.
function ControlsDisabled: Boolean
Dataset protected
Returns native object
property Dataset: TDataSet read
DisableControls protected
Disables data display in data-aware controls associated with the dataset.
procedure DisableControls
EnableControls protected
Enables data display in data-aware controls associated with the dataset.
procedure EnableControls
FieldCount protected
Returns TDataSet of the referred dataset.
function FieldCount: Integer
FindField protected
Returns an item with the specified name.
function FindField(const FieldName: string): IDANativeField
Parameters:
- FieldName: name of the searched field
FreeBookmark protected
Frees the resources allocated for a specified bookmark.
procedure FreeBookmark(Bookmark: TBookmark)
Parameters:
- Bookmark: bookmark that should be freed
GetActive protected
Returns TDataSet of the referred dataset.
function GetActive: Boolean
GetBOF protected
Returns TDataSet of the referred dataset.
function GetBOF: Boolean
GetBookMark protected
Allocates a bookmark for the active record
function GetBookMark: Pointer
GetEOF protected
Returns TDataSet of the referred dataset.
function GetEOF: Boolean
GetFieldName protected
Returns the field name assosiated with the field index.
function GetFieldName(Index: Integer): string
Parameters:
- Index: Index of the field
GetFields protected
Returns the field on the Index
position as IDANativeField.
function GetFields(Index: Integer): IDANativeField
Parameters:
- Index: position.
GetIsEmpty protected
Returns TDataSet of the referred dataset.
function GetIsEmpty: Boolean
GetNativeFieldData protected
Sets the DataSize
to the according field size value, allocates the Data
memory and copies the content of the field.
function GetNativeFieldData(Index: Integer; var Buffer: TBytes): Boolean
Parameters:
- Index: Required field index
- Buffer: Buffer
GetNativeFieldDataType protected
Returns the field type of the Index
field
function GetNativeFieldDataType(Index: Integer): TFieldType
Parameters:
- Index: Required field
GetNativeFieldValue protected virtual
Returns the value of the Index
field as Variant.
function GetNativeFieldValue(Index: Integer): Variant
Parameters:
- Index: Required field
GetRecordCount protected
Returns TDataSet of the referred dataset.
function GetRecordCount: Integer
GetState protected
Returns TDataSet of the referred dataset.
function GetState: TDatasetState
GotoBookmark protected
Positions on the record to which a specified bookmark points.
procedure GotoBookmark(Bookmark: TBookmark)
Parameters:
- Bookmark: record identified by this
Bookmark
should be active
IsTDatasetCompatible protected
Returns True.
function IsTDatasetCompatible: Boolean
Locate protected
Returns TDataSet.Locate(KeyFields, KeyValues, Options)
of the referred dataset.
function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean
Parameters:
- KeyFields: The semicolon-separated list of fields.
- KeyValues: Values specified by the Variant or Variant array.
- Options: Indicates whether the search is case insensitive and whether partial matches are supported.
Lookup protected
Returns TDataSet.Lookup(KeyFields, KeyValues, ResultFields)
of the referred dataset.
function Lookup(const KeyFields: string; const KeyValues: Variant; const ResultFields: string): Variant
Parameters:
- KeyFields: the semicolon-separated list of fields
- KeyValues: Values specified by the Variant or Variant array.
- ResultFields: The semicolon-separated list of result fields.
Next protected
Calls TDataSet of the referred dataset.
procedure Next
Prepare protected
Sets the property Prepared of the referred dataset to AValue
.
procedure Prepare(const AValue: Boolean)
Parameters:
- AValue: state
SetActive protected virtual
Calls TDataSet of the referred dataset to aValue
.
If aValue
is true, it fills the internal list of IDANativeField proxies.
procedure SetActive(const aValue: Boolean)
Parameters:
- aValue: state
Dataset protected
Returns native object
property Dataset: TDataSet read
constructor Create
Creates a new instance.
constructor Create(aDADataset: TDAESQLCommand)
Parameters:
- aDADataset: owner
CanFreeNativeFieldData protected
Specifies that given field can destroy pointer returned in GetNativeFieldData method
function CanFreeNativeFieldData: Boolean
CanUseNativeFieldData protected
Specifies that given field can return data in GetNativeFieldData method
function CanUseNativeFieldData(Index: Integer): Boolean
Parameters:
- Index: Required field index
ClearFieldDefs protected
Clears field definitions
procedure ClearFieldDefs
ControlsDisabled protected
Indicates whether data-aware controls update their display to reflect changes to the dataset.
function ControlsDisabled: Boolean
DisableControls protected
Disables data display in data-aware controls associated with the dataset.
procedure DisableControls
EnableControls protected
Enables data display in data-aware controls associated with the dataset.
procedure EnableControls
FieldCount protected
Returns TDataSet of the referred dataset.
function FieldCount: Integer
FindField protected
Returns an item with the specified name.
function FindField(const FieldName: string): IDANativeField
Parameters:
- FieldName: name of the searched field
FreeBookmark protected
Frees the resources allocated for a specified bookmark.
procedure FreeBookmark(Bookmark: TBookmark)
Parameters:
- Bookmark: bookmark that should be freed
GetActive protected
Returns TDataSet of the referred dataset.
function GetActive: Boolean
GetBOF protected
Returns TDataSet of the referred dataset.
function GetBOF: Boolean
GetBookMark protected
Allocates a bookmark for the active record
function GetBookMark: Pointer
GetEOF protected
Returns TDataSet of the referred dataset.
function GetEOF: Boolean
GetFieldName protected
Returns the field name assosiated with the field index.
function GetFieldName(Index: Integer): string
Parameters:
- Index: Index of the field
GetFields protected
Returns the field on the Index
position as IDANativeField.
function GetFields(Index: Integer): IDANativeField
Parameters:
- Index: position.
GetIsEmpty protected
Returns TDataSet of the referred dataset.
function GetIsEmpty: Boolean
GetNativeFieldData protected
Sets the DataSize
to the according field size value, allocates the Data
memory and copies the content of the field.
function GetNativeFieldData(Index: Integer; var Buffer: TBytes): Boolean
Parameters:
- Index: Required field index
- Buffer: Buffer
GetNativeFieldDataType protected
Returns the field type of the Index
field
function GetNativeFieldDataType(Index: Integer): TFieldType
Parameters:
- Index: Required field
GetNativeFieldValue protected virtual
Returns the value of the Index
field as Variant.
function GetNativeFieldValue(Index: Integer): Variant
Parameters:
- Index: Required field
GetRecordCount protected
Returns TDataSet of the referred dataset.
function GetRecordCount: Integer
GetState protected
Returns TDataSet of the referred dataset.
function GetState: TDatasetState
GotoBookmark protected
Positions on the record to which a specified bookmark points.
procedure GotoBookmark(Bookmark: TBookmark)
Parameters:
- Bookmark: record identified by this
Bookmark
should be active
IsTDatasetCompatible protected
Returns True.
function IsTDatasetCompatible: Boolean
Locate protected
Returns TDataSet.Locate(KeyFields, KeyValues, Options)
of the referred dataset.
function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean
Parameters:
- KeyFields: The semicolon-separated list of fields.
- KeyValues: Values specified by the Variant or Variant array.
- Options: Indicates whether the search is case insensitive and whether partial matches are supported.
Lookup protected
Returns TDataSet.Lookup(KeyFields, KeyValues, ResultFields)
of the referred dataset.
function Lookup(const KeyFields: string; const KeyValues: Variant; const ResultFields: string): Variant
Parameters:
- KeyFields: the semicolon-separated list of fields
- KeyValues: Values specified by the Variant or Variant array.
- ResultFields: The semicolon-separated list of result fields.
Next protected
Calls TDataSet of the referred dataset.
procedure Next
Prepare protected
Sets the property Prepared of the referred dataset to AValue
.
procedure Prepare(const AValue: Boolean)
Parameters:
- AValue: state
SetActive protected virtual
Calls TDataSet of the referred dataset to aValue
.
If aValue
is true, it fills the internal list of IDANativeField proxies.
procedure SetActive(const aValue: Boolean)
Parameters:
- aValue: state