IBX.IBQuery.TIBQuery.PSSetCommandText

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure PSSetCommandText(const CommandText: string); override;

C++

virtual void __fastcall PSSetCommandText(const System::UnicodeString CommandText);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
IBX.IBQuery.pas
IBX.IBQuery.hpp
IBX.IBQuery TIBQuery

Description

Assigns a specified SQL command to be executed by PSExecute.

IBX.IBQuery.TIBQuery.PSSetCommandText inherits from Data.DB.TDataSet.PSSetCommandText. All content below this line refers to Data.DB.TDataSet.PSSetCommandText.

Assigns a specified 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 GetRecords or Execute. This command is passed to the dataset by a call to PSSetCommandText, and subsequently executed by a call to PSExecute.

The value of the CommandText parameter replaces the dataset's SQL statement (if it has one), or replaces the name of an underlying database table or stored procedure.

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

See Also