Datasnap.Xmlxform.TXMLTransformClient.SetParams

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

Delphi

procedure SetParams(const ParamsXml, ParamsTransformFile: string);

C++

void __fastcall SetParams(const System::UnicodeString ParamsXml, const System::UnicodeString ParamsTransformFile);

プロパティ

種類 可視性 ソース ユニット
procedure
function
public
Datasnap.Xmlxform.pas
Datasnap.Xmlxform.hpp
Datasnap.Xmlxform TXMLTransformClient

説明

入力パラメータを XML ドキュメントで供給された値に設定します。

SetParams メソッドを呼び出すと,プロバイダからデータをフェッチする前に入力パラメータ値を供給できます。パラメータ値は問い合わせまたはストアドプロシージャへの入力パラメータを表すか,プロバイダが TTable または TSQLTable コンポーネントのデータを表す場合に,データをフィルタ処理する項目値を表すことができます。

ParamsXML は,設定するパラメータ値を表す XML ドキュメントです。通常は,XML ドキュメントファイルの内容が格納されます。

ParamsTransformFile は,ParamsXml をデータパケットに変換する変換ファイルの名前です。変換ファイルとは,拡張子が .xtr の特殊な XML ファイルのことです。変換ファイルは,特定の XML スキーマおよびデータパケット形式に固有です。xmlmapper.exe ユーティリティを使用すると,変換ファイルを作成できます。

メモ:  ParamsTransformFile にユーザー定義の変換が含まれている場合,SetParams で指定されたコンポーネントは ParamsXml 文字列のユーザー定義ノードを対応するパラメータ値に変換する必要があるときに OnTranslate イベントを生成します。

TXMLTransformClient コンポーネントは,パラメータ値を内部に格納します。SetParams を呼び出すたびに,内部に格納されたそれらの値が更新されます。以前の呼び出しからのパラメータ値はクリアされないので,必ず,変更する必要のあるすべてのパラメータ値を設定するようにしてください。

次回に GetDataAsXml メソッドが呼び出されると,TXMLTransformClient は現在格納されているパラメータ値をプロバイダに送信します。

関連項目