Datasnap.DBClient.TCustomClientDataSet.GetFieldData
Delphi
function GetFieldData(Field: TField; var Buffer: TValueBuffer): Boolean; overload; override;
function GetFieldData(FieldNo: Integer; var Buffer: TValueBuffer): Boolean; overload; override;
function GetFieldData(Field: TField; Buffer: Pointer): Boolean; overload; override; deprecated 'Use overloaded method instead';
function GetFieldData(FieldNo: Integer; Buffer: Pointer): Boolean; overload; override; deprecated 'Use overloaded method instead';
C++
virtual bool __fastcall GetFieldData(Data::Db::TField* Field, System::DynamicArray<System::Byte> &Buffer)/* overload */;
virtual bool __fastcall GetFieldData(int FieldNo, System::DynamicArray<System::Byte> &Buffer)/* overload */;
virtual bool __fastcall GetFieldData _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (Data::Db::TField* Field, void * Buffer)/* overload */;
virtual bool __fastcall GetFieldData _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (int FieldNo, void * Buffer)/* overload */;
inline bool __fastcall GetFieldData(Data::Db::TField* Field, System::DynamicArray<System::Byte> &Buffer, bool NativeFormat){ return Data::Db::TDataSet::GetFieldData(Field, Buffer, NativeFormat); }
inline bool __fastcall GetFieldData _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (Data::Db::TField* Field, void * Buffer, bool NativeFormat){ return Data::Db::TDataSet::GetFieldData(Field, Buffer, NativeFormat); }
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
function | public | Datasnap.DBClient.pas Datasnap.DBClient.hpp |
Datasnap.DBClient | TCustomClientDataSet |
Description
Retrieves the current value of a field.
Call GetFieldData to obtain the value of a field component as it is stored in the record buffer. TField objects call GetFieldData to implement their GetData method.
The Field
or FieldNo
parameter indicates the field whose data should be fetched. Field
specifies the component itself, while FieldNo
indicates its field number. The Buffer
parameter is a memory buffer with sufficient space to accept the value of the field as it exists in the database (unformatted and untranslated). NativeFormat
indicates whether the dataset fetches the field in the IDE's native format for the field type. When NativeFormat
is False, the dataset must convert the field value to the native type using its Translate method. This allows the field to handle data from different types of datasets (ADO-based, BDE-based, and so on) in a uniform manner.
GetFieldData returns a value that indicates whether the data was successfully fetched.