Show: Delphi C++
Display Preferences

Data.DB.TDataSet.GetFieldData

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetFieldData(Field: TField; var Buffer: TValueBuffer): Boolean; overload; virtual;
function GetFieldData(FieldNo: Integer; var Buffer: TValueBuffer): Boolean; overload; virtual;
function GetFieldData(Field: TField; var Buffer: TValueBuffer; NativeFormat: Boolean): Boolean; overload; virtual;
function GetFieldData(Field: TField; Buffer: Pointer): Boolean; overload; virtual; deprecated 'Use overloaded method instead';
function GetFieldData(FieldNo: Integer; Buffer: Pointer): Boolean; overload; virtual; deprecated 'Use overloaded method instead';
function GetFieldData(Field: TField; Buffer: Pointer; NativeFormat: Boolean): Boolean; overload; virtual; deprecated 'Use overloaded method instead';

C++

virtual bool __fastcall GetFieldData(TField* Field, System::DynamicArray<System::Byte> &Buffer)/* overload */;
virtual bool __fastcall GetFieldData(int FieldNo, System::DynamicArray<System::Byte> &Buffer)/* overload */;
virtual bool __fastcall GetFieldData(TField* Field, System::DynamicArray<System::Byte> &Buffer, bool NativeFormat)/* overload */;
virtual bool __fastcall GetFieldData _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (TField* Field, void * Buffer)/* overload */;
virtual bool __fastcall GetFieldData _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (int FieldNo, void * Buffer)/* overload */;
virtual bool __fastcall GetFieldData _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (TField* Field, void * Buffer, bool NativeFormat)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.DB.pas
Data.DB.hpp
Data.DB TDataSet

Description

Retrieves the current value of a field into a buffer.

Most applications do not need to call GetFieldData. TField objects call this method 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. This allows the field to handle data from different types of datasets (ADO-based and so on) in a uniform manner.

GetFieldData returns a value that indicates whether the data was successfully fetched.

As implemented in TDataSet, GetFieldData always returns false, indicating that no data was fetched from the specified field. Descendants override this method to fetch data in whatever way is appropriate to the implementation of the dataset.

Note: TDataSet.GetFieldData method expects Integer and Cardinal values instead of LongInt for ftInteger and LongWord for ftLongword.


See Also

Personal tools
RAD Studio 10.2 Tokyo
In Other Languages
Previous Versions
Assistance