Datasnap.DBClient.TCustomClientDataSet.GetOptionalParam

• 親: TCustomClientDataSet

Delphi

function GetOptionalParam(const ParamName: string): OleVariant;

C++

System::OleVariant __fastcall GetOptionalParam(const System::UnicodeString ParamName);

プロパティ

種類	可視性	ソース	ユニット	親
function	public	Datasnap.DBClient.pas Datasnap.DBClient.hpp	Datasnap.DBClient	TCustomClientDataSet

説明

データパケットからカスタムパラメータを取り出します。

アプリケーション開発者は，クライアントデータセットの SetOptionalParam メソッドまたはプロバイダの OnGetDataSetProperties イベントを使用して，データパケットにカスタム情報を追加できます。この情報は，ファイルまたはストリームに保存するときに，データパケットとともに保存され，Data プロパティの値とともにコピーされます。GetOptionalParam メソッドを呼び出すと，データパケットからこのカスタム情報を取り出すことができます。

ParamName パラメータは，カスタム情報を格納する際に付ける名前を指定します。

メモ：  このメソッドで取得されるオプションデータと Params プロパティを混同しないでください。

関連項目

• SetOptionalParam

• Data

• OnGetDataSetProperties

• アプリケーション固有の情報をデータに追加する

• データ パケットにカスタム情報を追加する