Soap.SOAPDm.TSoapDataModule.SAS_GetParams

From RAD Studio API Documentation
Jump to: navigation, search


Delphi

function  SAS_GetParams(const ProviderName: OleStr; var OwnerData: OleVariant): OleVariant; virtual; stdcall;

C++

virtual System::OleVariant __stdcall SAS_GetParams(const System::WideString ProviderName, System::OleVariant &OwnerData);

Properties

Type Visibility Source Unit Parent
function protected
Soap.SOAPDm.pas
Soap.SOAPDm.hpp
Soap.SOAPDm TSoapDataModule

Description

Fetches current parameter values from the dataset bound to a specified provider.

Use SAS_SAS_GetParams to retrieve the current parameter values from the dataset associated with a provider.

ProviderName specifies the name of the provider component whose dataset has the parameters.

OwnerData represents custom information that originates in a client dataset's BeforeSAS_GetParams event handler and returns information that is passed to the client dataset's AfterSAS_GetParams event handler.

SAS_SAS_GetParams returns the parameters, encoded as a Variant array, or, if the provider does not support parameter fetching, SAS_SAS_GetParams returns a Null Variant. Use the UnpackParams procedure to convert parameter values returned by SAS_SAS_GetParams to a TParams object.

Warning: It is not a good idea to call SAS_SAS_GetParams on a SOAP data module. SOAP data modules are stateless, and any parameter values you fetch may be changed by other applications. The recommended way to obtain output parameter values is to call the SAS_Execute method instead.

Note: Applications can only call the protected SAS_SAS_GetParams method using the IAppServerSOAP interface.

See Also