Datasnap.DBClient.TCustomClientDataSet.ExecuteCommand

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type:
procedure
function
Visibility: protected
Source:
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Unit: Datasnap.DBClient
Parent: TCustomClientDataSet

Delphi

procedure ExecuteCommand(const ACommand: string; const Args: array of const); virtual;

C++

virtual void __fastcall ExecuteCommand(const System::UnicodeString ACommand, const System::TVarRec *Args, const System::NativeInt Args_High);

Description

Executes an extended command of a TDataSet descendant.

ExecuteCommand executes an extended command of a TClientDataSet descendant given by parameter.

The method takes two parameters.

The ACommand parameter is the command to execute. To be supported, the ACommand must be one of the following:

Value Meaning

sApplyUpdatesDataSetCommand

Writes changes for all the changed records (inserted, deleted, or edited) to the database.

sCancelUpdatesDataSetCommand

Cancels edits for all edited records, restores the record display to its condition prior to editing, and turns off Insert and Edit.

TClientDataSet has two extended commands: ApplyUpdates and CancelUpdates.

The Args parameter is an argument that represents the maximum number of errors that may occur when the command is executed.

See Also