Datasnap.DBClient.TCustomClientDataSet.SetOptionalParam
Delphi
procedure SetOptionalParam(const ParamName: string; const Value: OleVariant; IncludeInDelta: Boolean = False); virtual;
C++
virtual void __fastcall SetOptionalParam(const System::UnicodeString ParamName, const System::OleVariant &Value, bool IncludeInDelta = false);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
procedure function |
public | Datasnap.DBClient.pas Datasnap.DBClient.hpp |
Datasnap.DBClient | TCustomClientDataSet |
説明
カスタムパラメータをデータパケットとともに保存します。
SetOptionalParam メソッドを呼び出すと，データパケットにカスタム情報を追加できます。この情報は，ファイルまたはストリームに保存するときに，データパケットとともに保存され，Data プロパティの値とともにコピーされます。たとえば，プロバイダの OnGetData イベントでパラメータを設定すると，アプリケーションサーバーは，クライアントアプリケーションに送信されるデータにカスタム情報を追加できます。GetOptionalParam メソッドを呼び出すと，データパケットからカスタム情報を取り出すことができます。
ParamName パラメータは，格納時にカスタム情報に付ける名前を指定します。以下に示す値以外の値を使用します。
|
UNIQUE_KEY |
DEFAULT_ORDER |
CHANGE_LOG |
SERVER_COL |
|
CONSTRAINTS |
DATASET_CONTEXT |
DATASET_DELTA |
LCID |
|
BDERECORD_X |
TABLE_NAME |
MD_FIELDLINKS |
UPDATEMODE |
Value パラメータは，カスタム情報を表す OleVariant です。
IncludeInDelta パラメータは，パラメータを Delta プロパティとともに格納するかどうかを指定します。Delta プロパティに指定すると，このパラメータは更新データとともにプロバイダに送信されます。プロバイダは，OnUpdateData イベントハンドラにパラメータとして渡されたクライアントデータセットの GetOptionalParam メソッドを使ってこの情報を取得できます。
メモ： このメソッドによって保存されるオプションのデータと，Params プロパティを混同しないでください。