Data.SqlExpr.TCustomSQLDataSet.PSGetCommandText

From RAD Studio API Documentation

Delphi

function PSGetCommandText: string; override;

C++

virtual System::UnicodeString __fastcall PSGetCommandText(void);

Properties

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

Description

Gets the SQL command to be executed by PSExecute. {{#multireplace:Data.SqlExpr.TCustomSQLDataSet.PSGetCommandText|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}} inherits from {{#multireplace:Data.DB.TDataSet.PSGetCommandText|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}}. All content below this line refers to {{#multireplace:Data.DB.TDataSet.PSGetCommandText|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}}.

Gets the SQL command to be executed by PSExecute.

If the provider's Options property includes poAllowCommandText, clients can supply an SQL command along with a call to TCustomProvider.GetRecords or TCustomProvider.Execute. This command is passed to the dataset by a call to PSSetCommandText, and subsequently executed by a call to PSExecute.

This method is an implementation of the IProviderSupport.PSGetCommandText method and, by default, returns an empty string, because TDataSet does not implement a provider by default. To use it, every TDataSet descendant must override it in its specific way.

See Also