Soap.SOAPMidas.IAppServerSOAP.SAS_Execute

From RAD Studio API Documentation
Jump to: navigation, search


Delphi

procedure SAS_Execute(const ProviderName: OleStr; const CommandText: OleStr;  var Params: OleVariant; var OwnerData: OleVariant); stdcall;

C++

virtual void __stdcall SAS_Execute(const System::WideString ProviderName, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData) = 0 ;

Properties

Type Visibility Source Unit Parent
procedure
function
public
Soap.SOAPMidas.pas
Soap.SOAPMidas.hpp
Soap.SOAPMidas IAppServerSOAP

Description

SAS_Execute executes the query or stored procedure bound to a specified provider.

Use SAS_SAS_Execute to pass an execute command to a remote provider, using a specified set of parameters. SAS_SAS_Execute calls the SAS_Execute method of the specified provider after assigning any parameters. Output parameters that result from executing a query or stored procedure are returned in the Params parameter.

The provider's SAS_Execute method generates a BeforeSAS_Execute event, passes the command on to its associated dataset, and generates an AfterSAS_Execute event. The dataset must represent a query or stored procedure that does not return a cursor.

ProviderName specifies the name of the provider component associated with the query or stored procedure.

CommandText specifies an optional SQL statement that replaces the SQL of the query, or the name of a stored procedure that replaces the dataset's stored procedure. This parameter is ignored if the provider's Options property does not include poAllowCommandText.

Params encodes any parameters expected by the query or stored procedure and returns any output parameters. To create a properly encoded value for Params from a TParams object, use the PackageParams method. To decode Params into a TParams object, use the Unpackparams routine.

OwnerData contains custom information that appears as an argument to the provider's BeforeSAS_Execute and AfterSAS_Execute event handlers. This information originates in a client dataset's BeforeSAS_Execute event handler. The value returned in OwnerData is passed to the client dataset's AfterSAS_Execute event handler.

See Also