Data.SqlExpr.TCustomSQLDataSet.PSExecuteStatement

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function PSExecuteStatement(const ASQL: string; AParams: TParams): Integer; overload; override;
function PSExecuteStatement(const ASQL: string; AParams: TParams;  var ResultSet: TDataSet): Integer; overload; override;
function PSExecuteStatement(const ASQL: string; AParams: TParams;  ResultSet: Pointer = nil): Integer; overload; override; deprecated 'Use overloaded method instead';

C++

virtual int __fastcall PSExecuteStatement(const System::UnicodeString ASQL, Data::Db::TParams* AParams)/* overload */;
virtual int __fastcall PSExecuteStatement(const System::UnicodeString ASQL, Data::Db::TParams* AParams, Data::Db::TDataSet* &ResultSet)/* overload */;
virtual int __fastcall PSExecuteStatement _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (const System::UnicodeString ASQL, Data::Db::TParams* AParams, void * ResultSet = (void *)(0x0))/* overload */;

Properties

Type Visibility Source Unit Parent
function protected
Data.SqlExpr.pas
Data.SqlExpr.hpp
Data.SqlExpr TCustomSQLDataSet

Description

Executes a specified SQL command.

Data.SqlExpr.TCustomSQLDataSet.PSExecuteStatement inherits from Data.DB.TDataSet.PSExecuteStatement. All content below this line refers to Data.DB.TDataSet.PSExecuteStatement.

Executes a specified SQL command.

If the value of ResolveToDataSet property is False, a provider component calls PSExecuteStatement (indirectly) to execute SQL statements that it generates for applying updates. Usually, the dataset passes these statements on to its database server for execution.

The ASQL parameter specifies the SQL command to execute.

AParams contains any parameter values that should be applied to ASQL before execution.

ResultSet allows PSExecuteStatement to return a dataset component that contains the results of a SELECT statement. If ResultSet is not nil (Delphi) or NULL (C++), PSExecuteStatement creates a new dataset component as the target of this pointer and fills it with the result set. The caller is responsible for freeing the dataset.

This method is an implementation of IProviderSupport.PSExecuteStatement and, by default, returns 0. To use it, every TDataSet descendant must override it in its specific way.

PSExecuteStatement returns the number of rows affected by executing ASQL.

See Also