DBClient.TCustomClientDataSet Methods

From RAD Studio VCL Reference
Jump to: navigation, search

Delphi Information

procedure DoAfterApplyUpdates(var OwnerData: OleVariant); virtual;
procedure DoBeforeApplyUpdates(var OwnerData: OleVariant); virtual;
function DoApplyUpdates(Delta: OleVariant;

MaxErrors: Integer;

out ErrorCount: Integer): OleVariant; virtual;
procedure DoAfterGetParams(var OwnerData: OleVariant); virtual;
procedure DoBeforeGetParams(var OwnerData: OleVariant); virtual;
procedure DoAfterGetRecords(var OwnerData: OleVariant); virtual;
procedure DoBeforeGetRecords(var OwnerData: OleVariant); virtual;
function DoGetRecords(Count: Integer;

out RecsOut: Integer; Options: Integer; const CommandText: WideString;

Params: OleVariant): OleVariant; virtual;
procedure DoAfterRowRequest(var OwnerData: OleVariant); virtual;
procedure DoBeforeRowRequest(var OwnerData: OleVariant); virtual;
function DoRowRequest(Row: OleVariant; RequestType: Integer): OleVariant; virtual;
procedure DoAfterExecute(var OwnerData: OleVariant); virtual;
procedure DoBeforeExecute(var OwnerData: OleVariant); virtual;
procedure DoExecute(Params: OleVariant); virtual;
procedure ActivateFilters
procedure AddDataPacket(const Data: OleVariant; HitEOF: Boolean); virtual;
procedure AddFieldDesc(FieldDescs: TFieldDescList;

var DescNo: Integer; var FieldID: Integer;

FieldDefs: TFieldDefs);
procedure AllocKeyBuffers
procedure Check(Status: Word);
procedure CheckDetailRecords virtual;
procedure CheckProviderEOF virtual;
procedure CheckSetKeyMode
procedure DeactivateFilters
procedure DestroyLookupCursor virtual;
procedure FetchMoreData(All: Boolean); virtual;
procedure FreeKeyBuffers
function GetAppServer(): IAppServer; virtual;
procedure GetBookmarkData(Buffer: PByte; Data: Pointer); overload; override;
function GetIndexField(Index: Integer): TField;
function GetIndexFieldCount(): Integer;
function GetIsClone(): Boolean; virtual;
function GetKeyBuffer(KeyIndex: TKeyIndex): PKeyBuffer;
function GetKeyExclusive(): Boolean;
function GetKeyFieldCount(): Integer;
function GetRemoteServer(): TCustomRemoteServer; virtual;
function InitKeyBuffer(Buffer: PKeyBuffer): PKeyBuffer;
function InternalGetOptionalParam(const ParamName: string; FieldNo: Integer = $0): OleVariant;
procedure InternalSetOptionalParam(const ParamName: string;

const Value: OleVariant; IncludeInDelta: Boolean = False;

FieldNo: Integer = $0);
function LocateRecord(const KeyFields: string;

const KeyValues: Variant; Options: TLocateOptions;

SyncCursor: Boolean): Boolean;

Searches the dataset for a specified record.

procedure PostKeyBuffer(Commit: Boolean);
procedure ReadDataPacket(Stream: TStream; ReadSize: Boolean);
function ResetCursorRange(): Boolean;
procedure SetAggregates(Value: TAggregates); virtual;
procedure SetAppServer(Value: IAppServer); virtual;
procedure SetBookmarkData(Buffer: PByte; Data: Pointer); overload; override;
procedure SetCommandText(Value: WideString); virtual;
function SetCursorRange(): Boolean;
procedure SetFieldData(Field: TField; Buffer: Pointer); overload; override;
procedure SetFilterData(const Text: string; Options: TFilterOptions);
procedure SetIndexField(Index: Integer; Value: TField);
procedure SetKeyBuffer(KeyIndex: TKeyIndex; Clear: Boolean);
procedure SetKeyExclusive(Value: Boolean);
procedure SetKeyFieldCount(Value: Integer);
procedure SetKeyFields(KeyIndex: TKeyIndex; const Values: array of TVarRec);
procedure SetLinkRanges(MasterFields: TList);
procedure SetProviderEOF(Value: Boolean); virtual;
procedure SetRemoteServer(Value: TCustomRemoteServer); virtual;
procedure SwitchToIndex(const IndexName: string);
procedure SyncCursors(Cursor1: IDSCursor; Cursor2: IDSCursor);
procedure WriteDataPacket(Stream: TStream; WriteSize: Boolean; Format: TDataPacketFormat = dfBinary);
function ConstraintsStored(): Boolean;
procedure AddIndex(const Name: string;

const Fields: string; Options: TIndexOptions; const DescFields: string = ; const CaseInsFields: string = ;

const GroupingLevel: Integer = $0);

Creates a new index for the client dataset.

procedure AppendData(const Data: OleVariant; HitEOF: Boolean);

Adds a newly fetched packet of records to those already stored in the client dataset.

procedure ApplyRange

Applies a range to the dataset.

function ApplyUpdates(MaxErrors: Integer): Integer; virtual;

Sends all updated, inserted, and deleted records from the client dataset to the provider for writing to the database.

procedure CancelRange

Removes any ranges currently in effect for the client dataset.

procedure CancelUpdates

Clears all pending edits and clears the change log.

procedure CreateDataSet

Creates a new, empty client dataset.

procedure CloneCursor(Source: TCustomClientDataSet; Reset: Boolean; KeepSettings: Boolean = False); virtual;

Shares the data belonging to another client dataset.

function ConstraintsDisabled(): Boolean;

Indicates whether constraints are enabled for a client dataset.

function DataRequest(Data: OleVariant): OleVariant; virtual;

Generates an OnDataRequest event on the associated provider

procedure DeleteIndex(const Name: string);

Deletes an index for the client dataset.

procedure DisableConstraints

Disables the enforcement of constraints.

procedure EnableConstraints

Reenables enforcement of constraints when records are posted.

procedure EditKey

Enables modification of the search key buffer.

procedure EditRangeEnd

Enables changing the ending value for an existing range.

procedure EditRangeStart

Enables changing the starting value for an existing range.

procedure EmptyDataSet virtual;

Removes all records from the dataset.

procedure Execute virtual;

Executes an SQL command by the provider's dataset.

procedure FetchBlobs

Retrieves BLOB field values from the provider.

procedure FetchDetails

Retrieves nested detail datasets from the provider.

procedure RefreshRecord

Updates the base values of the current record to match the current values of the provider's dataset.

procedure FetchParams

Retrieves parameter values from the provider.

function FindKey(const KeyValues: array of TVarRec): Boolean; virtual;

Searches for a record containing specified field values.

procedure FindNearest(const KeyValues: array of TVarRec);

Moves the cursor to the record that most closely matches a specified set of key values.

function GetFieldData(Field: TField; Buffer: Pointer): Boolean; overload; override;

Retrieves the current value of a field.

function GetFieldData(FieldNo: Integer; Buffer: Pointer): Boolean; overload; override;

Retrieves the current value of a field.

function GetGroupState(Level: Integer): TGroupPosInds;

Indicates where the current record sits within a specified group of records.

procedure GetIndexInfo(IndexName: string);

Retrieves information about the current index.

procedure GetIndexNames(List: TStrings);

Retrieves a list of available indexes for a client dataset.

function GetNextPacket(): Integer; virtual;

Retrieves the next block of records from the provider.

function GetOptionalParam(const ParamName: string): OleVariant;

Retrieves a custom parameter from the data packet.

procedure GotoCurrent(DataSet: TCustomClientDataSet);

Sets the current record in this dataset the same as the current record in another, cloned dataset.

function GotoKey(): Boolean;

Moves the cursor to a record specified by the current key.

procedure GotoNearest

Moves the cursor to the record that most closely matches the current key.

procedure LoadFromFile(const FileName: string =);

Loads a client dataset's data from a file.

procedure LoadFromStream(Stream: TStream);

Loads a client dataset's data from a stream.

procedure MergeChangeLog

Merges any data changes in the change log into the client dataset, overwriting existing values.

function Reconcile(const Results: OleVariant): Boolean;

Clears successfully updated records from the client dataset's cache of changes.

procedure RevertRecord

Undoes edits to the current record.

procedure SaveToFile(const FileName: string = ; Format: TDataPacketFormat = dfBinary);

Saves a client dataset's data to an external file.

procedure SaveToStream(Stream: TStream; Format: TDataPacketFormat = dfBinary);

Saves a client dataset's data to a stream.

procedure SetAltRecBuffers(Old: PByte; New: PByte; Cur: PByte);

Sets record buffers when accessing field values.

procedure SetKey

Enables setting of keys and ranges for a dataset prior to a search.

procedure SetOptionalParam(const ParamName: string; const Value: OleVariant; IncludeInDelta: Boolean = False); virtual;

Saves a custom parameter with the data packet.

procedure SetProvider(Provider: TComponent);

Associates the client dataset with a provider in the same process space.

procedure SetRange(const StartValues: array of TVarRec; const EndValues: array of TVarRec);

Sets the starting and ending values of a range, and applies it.

procedure SetRangeEnd

Indicates that subsequent assignments to field values specify the end of the range of rows to include in the dataset.

procedure SetRangeStart

Indicates that subsequent assignments to field values specify the start of the range of rows to include in the dataset.

function UndoLastChange(FollowChange: Boolean): Boolean;

Undoes the last edit, insert, or delete operation to a record in the client dataset.


Unit: DBClient

Type: method

Visibility: public

Member Of: TCustomClientDataSet

C++ Information

virtual void __fastcall DoAfterApplyUpdates(System::OleVariant & OwnerData);
virtual void __fastcall DoBeforeApplyUpdates(System::OleVariant & OwnerData);
virtual System::OleVariant __fastcall DoApplyUpdates(const System::OleVariant & Delta, int MaxErrors, int & ErrorCount);
virtual void __fastcall DoAfterGetParams(System::OleVariant & OwnerData);
virtual void __fastcall DoBeforeGetParams(System::OleVariant & OwnerData);
virtual void __fastcall DoAfterGetRecords(System::OleVariant & OwnerData);
virtual void __fastcall DoBeforeGetRecords(System::OleVariant & OwnerData);
virtual System::OleVariant __fastcall DoGetRecords(int Count,

int & RecsOut, int Options, System::WideString CommandText,

const System::OleVariant & Params);
virtual void __fastcall DoAfterRowRequest(System::OleVariant & OwnerData);
virtual void __fastcall DoBeforeRowRequest(System::OleVariant & OwnerData);
virtual System::OleVariant __fastcall DoRowRequest(const System::OleVariant & Row, int RequestType);
virtual void __fastcall DoAfterExecute(System::OleVariant & OwnerData);
virtual void __fastcall DoBeforeExecute(System::OleVariant & OwnerData);
virtual void __fastcall DoExecute(const System::OleVariant & Params);
void __fastcall ActivateFilters(void);
virtual void __fastcall AddDataPacket(const System::OleVariant & Data, bool HitEOF);
void __fastcall AddFieldDesc(System::DynamicArray<Dsintf::DSFLDDesc> FieldDescs,

int & DescNo, int & FieldID,

Db::TFieldDefs * FieldDefs);
void __fastcall AllocKeyBuffers(void);
void __fastcall Check(unsigned short Status);
virtual void __fastcall CheckDetailRecords(void);
virtual void __fastcall CheckProviderEOF(void);
void __fastcall CheckSetKeyMode(void);
void __fastcall DeactivateFilters(void);
virtual void __fastcall DestroyLookupCursor(void);
virtual void __fastcall FetchMoreData(bool All);
void __fastcall FreeKeyBuffers(void);
virtual System::DelphiInterface<Midas::IAppServer> __fastcall GetAppServer(void);
Db::TField * __fastcall GetIndexField(int Index);
int __fastcall GetIndexFieldCount(void);
virtual bool __fastcall GetIsClone(void);
Dbclient::TKeyBuffer * __fastcall GetKeyBuffer(Dbcommontypes::TKeyIndex KeyIndex);
bool __fastcall GetKeyExclusive(void);
int __fastcall GetKeyFieldCount(void);
virtual Dbclient::TCustomRemoteServer * __fastcall GetRemoteServer(void);
Dbclient::TKeyBuffer * __fastcall InitKeyBuffer(Dbclient::TKeyBuffer * Buffer);
System::OleVariant __fastcall InternalGetOptionalParam(System::UnicodeString ParamName, int FieldNo);
void __fastcall InternalSetOptionalParam(System::UnicodeString ParamName,

const System::OleVariant & Value, bool IncludeInDelta,

int FieldNo);
bool __fastcall LocateRecord(System::UnicodeString KeyFields,

const System::Variant & KeyValues, System::Set<Db::TLocateOption,0,1> Options,

bool SyncCursor);

Searches the dataset for a specified record.

void __fastcall PostKeyBuffer(bool Commit);
void __fastcall ReadDataPacket(Classes::TStream * Stream, bool ReadSize);
bool __fastcall ResetCursorRange(void);
virtual void __fastcall SetAggregates(Dbclient::TAggregates * Value);
virtual void __fastcall SetAppServer(System::DelphiInterface<Midas::IAppServer> Value);
virtual void __fastcall SetCommandText(System::WideString Value);
bool __fastcall SetCursorRange(void);
void __fastcall SetFilterData(System::UnicodeString Text, System::Set<Db::TFilterOption,0,1> Options);
void __fastcall SetIndexField(int Index, Db::TField * Value);
void __fastcall SetKeyBuffer(Dbcommontypes::TKeyIndex KeyIndex, bool Clear);
void __fastcall SetKeyExclusive(bool Value);
void __fastcall SetKeyFieldCount(int Value);
void __fastcall SetKeyFields(Dbcommontypes::TKeyIndex KeyIndex, const System::TVarRec * Values, int Values_Size);
void __fastcall SetLinkRanges(Classes::TList * MasterFields);
virtual void __fastcall SetProviderEOF(bool Value);
virtual void __fastcall SetRemoteServer(Dbclient::TCustomRemoteServer * Value);
void __fastcall SwitchToIndex(System::UnicodeString IndexName);
void __fastcall SyncCursors(System::DelphiInterface<Dsintf::IDSCursor> Cursor1, System::DelphiInterface<Dsintf::IDSCursor> Cursor2);
void __fastcall WriteDataPacket(Classes::TStream * Stream, bool WriteSize, Dbclient::TDataPacketFormat Format);
bool __fastcall ConstraintsStored(void);
void __fastcall AddIndex(System::UnicodeString Name,

System::UnicodeString Fields, System::Set<Db::TIndexOption,0,5> Options, System::UnicodeString DescFields, System::UnicodeString CaseInsFields,

int GroupingLevel);

Creates a new index for the client dataset.

void __fastcall AppendData(const System::OleVariant & Data, bool HitEOF);

Adds a newly fetched packet of records to those already stored in the client dataset.

void __fastcall ApplyRange(void);

Applies a range to the dataset.

virtual int __fastcall ApplyUpdates(int MaxErrors);

Sends all updated, inserted, and deleted records from the client dataset to the provider for writing to the database.

void __fastcall CancelRange(void);

Removes any ranges currently in effect for the client dataset.

void __fastcall CancelUpdates(void);

Clears all pending edits and clears the change log.

void __fastcall CreateDataSet(void);

Creates a new, empty client dataset.

virtual void __fastcall CloneCursor(Dbclient::TCustomClientDataSet * Source, bool Reset, bool KeepSettings);

Shares the data belonging to another client dataset.

bool __fastcall ConstraintsDisabled(void);

Indicates whether constraints are enabled for a client dataset.

virtual System::OleVariant __fastcall DataRequest(const System::OleVariant & Data);

Generates an OnDataRequest event on the associated provider

void __fastcall DeleteIndex(System::UnicodeString Name);

Deletes an index for the client dataset.

void __fastcall DisableConstraints(void);

Disables the enforcement of constraints.

void __fastcall EnableConstraints(void);

Reenables enforcement of constraints when records are posted.

void __fastcall EditKey(void);

Enables modification of the search key buffer.

void __fastcall EditRangeEnd(void);

Enables changing the ending value for an existing range.

void __fastcall EditRangeStart(void);

Enables changing the starting value for an existing range.

virtual void __fastcall EmptyDataSet(void);

Removes all records from the dataset.

virtual void __fastcall Execute(void);

Executes an SQL command by the provider's dataset.

void __fastcall FetchBlobs(void);

Retrieves BLOB field values from the provider.

void __fastcall FetchDetails(void);

Retrieves nested detail datasets from the provider.

void __fastcall RefreshRecord(void);

Updates the base values of the current record to match the current values of the provider's dataset.

void __fastcall FetchParams(void);

Retrieves parameter values from the provider.

virtual bool __fastcall FindKey(const System::TVarRec * KeyValues, int KeyValues_Size);

Searches for a record containing specified field values.

void __fastcall FindNearest(const System::TVarRec * KeyValues, int KeyValues_Size);

Moves the cursor to the record that most closely matches a specified set of key values.

System::Set<Db::TGroupPosInd,0,2> __fastcall GetGroupState(int Level);

Indicates where the current record sits within a specified group of records.

void __fastcall GetIndexInfo(System::UnicodeString IndexName);

Retrieves information about the current index.

void __fastcall GetIndexNames(Classes::TStrings * List);

Retrieves a list of available indexes for a client dataset.

virtual int __fastcall GetNextPacket(void);

Retrieves the next block of records from the provider.

System::OleVariant __fastcall GetOptionalParam(System::UnicodeString ParamName);

Retrieves a custom parameter from the data packet.

void __fastcall GotoCurrent(Dbclient::TCustomClientDataSet * DataSet);

Sets the current record in this dataset the same as the current record in another, cloned dataset.

bool __fastcall GotoKey(void);

Moves the cursor to a record specified by the current key.

void __fastcall GotoNearest(void);

Moves the cursor to the record that most closely matches the current key.

void __fastcall LoadFromFile(System::UnicodeString FileName);

Loads a client dataset's data from a file.

void __fastcall LoadFromStream(Classes::TStream * Stream);

Loads a client dataset's data from a stream.

void __fastcall MergeChangeLog(void);

Merges any data changes in the change log into the client dataset, overwriting existing values.

bool __fastcall Reconcile(const System::OleVariant & Results);

Clears successfully updated records from the client dataset's cache of changes.

void __fastcall RevertRecord(void);

Undoes edits to the current record.

void __fastcall SaveToFile(System::UnicodeString FileName, Dbclient::TDataPacketFormat Format);

Saves a client dataset's data to an external file.

void __fastcall SaveToStream(Classes::TStream * Stream, Dbclient::TDataPacketFormat Format);

Saves a client dataset's data to a stream.

void __fastcall SetAltRecBuffers(unsigned char * Old, unsigned char * New, unsigned char * Cur);

Sets record buffers when accessing field values.

void __fastcall SetKey(void);

Enables setting of keys and ranges for a dataset prior to a search.

virtual void __fastcall SetOptionalParam(System::UnicodeString ParamName, const System::OleVariant & Value, bool IncludeInDelta);

Saves a custom parameter with the data packet.

void __fastcall SetProvider(Classes::TComponent * Provider);

Associates the client dataset with a provider in the same process space.

void __fastcall SetRange(const System::TVarRec * StartValues,

int StartValues_Size, const System::TVarRec * EndValues,

int EndValues_Size);

Sets the starting and ending values of a range, and applies it.

void __fastcall SetRangeEnd(void);

Indicates that subsequent assignments to field values specify the end of the range of rows to include in the dataset.

void __fastcall SetRangeStart(void);

Indicates that subsequent assignments to field values specify the start of the range of rows to include in the dataset.

bool __fastcall UndoLastChange(bool FollowChange);

Undoes the last edit, insert, or delete operation to a record in the client dataset.


Unit: DBClient

Type: method

Visibility: public

Member Of: TCustomClientDataSet


Description

Embarcadero Technologies does not currently have any additional information. Please help us document this topic by using the Discussion page!

Retrieved from "http://docwiki.embarcadero.com/VCL/2010/e/index.php?title=DBClient.TCustomClientDataSet_Methods&oldid=8584"
Personal tools
Translations
Newest Version