Datasnap.DSConnect.TDSProviderConnection.AS_GetParams

提供: RAD Studio API Documentation
移動先: 案内検索


Delphi

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

C++

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

プロパティ

種類 可視性 ソース ユニット
function protected
Datasnap.DSConnect.pas
Datasnap.DSConnect.hpp
Datasnap.DSConnect TDSProviderConnection

説明

現在のパラメータ値を、指定されたプロバイダにバインド済みのデータセットからフェッチします。

AS_GetParams を使用すると、現在のパラメータ値を、プロバイダに関連づけたデータセットから取得することができます。

ProviderName パラメータは、対象となるパラメータ群を保持しているデータセットを持つ、プロバイダ コンポーネントの名前を指定します。

OwnerData は、クライアント データセットの BeforeGetParams イベント ハンドラから提供する独自の情報を表すと共に、クライアント データセットの AfterGetParams イベント ハンドラへ渡す情報を返します。

AS_GetParams_result (C++)または AS_GetParams(Delphi)は、バリアント配列としてエンコードされたパラメータを返します。この配列の各要素は、2 次元バリアント配列で、名前パラメータと値パラメータをを保持しています。これらのパラメータは、TParams オブジェクトに UnpackParams プロシージャを使用して変換することができます。データセットにパラメータがない場合、もしくは、プロバイダがパラメータのフェッチをサポートしていない場合、AS_GetParams_result(C++)または AS_GetParams(Delphi)は、Null バリアントを返します。

関連項目