Soap.SOAPDm.TSoapDataModule.GetParams

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetParams(const ProviderName: OleStr; var OwnerData: OleVariant): OleVariant;

C++

System::OleVariant __fastcall 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.

GetParams provides the underlying implementation of the AS_GetParams method (on the IAppServer interface) and the SAS_GetParams method (on the IAppServerSOAP interface).

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

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

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

See Also