Datasnap.Win.MtsRdm.TMtsDataModule.AS_GetParams

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function AS_GetParams(const ProviderName: WideString; var OwnerData: OleVariant): OleVariant; safecall;

C++

HIDESBASE HRESULT __safecall AS_GetParams(const System::WideString ProviderName, System::OleVariant &OwnerData, System::OleVariant &__AS_GetParams_result);

Properties

Type Visibility Source Unit Parent
function protected
Datasnap.Win.MtsRdm.pas
Datasnap.Win.MtsRdm.hpp
Datasnap.Win.MtsRdm TMtsDataModule

Description

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

Datasnap.Win.MtsRdm.TMtsDataModule.AS GetParams inherits from Datasnap.DataBkr.TRemoteDataModule.AS_GetParams. All content below this line refers to Datasnap.DataBkr.TRemoteDataModule.AS_GetParams.

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

Use AS_GetParams to retrieve the current parameter values from the dataset associated with a provider. The ProviderName parameter specifies the name of the provider component whose dataset has the parameters. The 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.

AS_GetParams _result (C++) or AS_GetParams (Delphi) returns the parameters, encoded as a Variant array, or, if the provider does not support parameter fetching, it returns a Null Variant. Use the UnpackParams procedure to convert parameter values returned by AS_GetParams to a TParams object.

AS_GetParams should not be used to retrieve output parameters from stateless application servers, because parameter values may be changed by other applications. When writing a stateless application server, obtain output parameters using the AS_Execute method handler instead.

Note: Applications can only call the protected AS_GetParams method using the TRemoteDataModule interface.

See Also