Datasnap.Provider.TDataSetProvider.DoBeforeGetRecords
Delphi
procedure DoBeforeGetRecords(Count: Integer; Options: Integer; const CommandText: OleStr; var Params, OwnerData: OleVariant); override;
C++
virtual void __fastcall DoBeforeGetRecords(int Count, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData);
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
procedure function |
protected | Datasnap.Provider.pas Datasnap.Provider.hpp |
Datasnap.Provider | TDataSetProvider |
説明
BeforeGetRecords イベントを生成します。
GetRecords メソッドは,データを取り出したり,データをデータパケットにアセンブルする前に DoBeforeGetRecords を呼び出して BeforeGetRecords イベントを生成します。
Count パラメータは,要求されたレコードの数です。TDataSetProvider はこのパラメータを使用しません。
Options パラメータは,データパケットにメタデータを含むかどうか,最初のレコードから開始するかどうか,およびデータパケットを XML でコード化するかどうかを示します。TDataSetProvider では,DoBeforeGetRecords はこのパラメータを無視します。
CommandText パラメータは,関連する問い合わせの SQL を置換するオプションの SQL 文,または関連するストアドプロシージャを置換するストアドプロシージャの名前を指定します。Options パラメータに poAllowCommandText が含まれる場合,DoBeforeGetRecords は CommandText パラメータを関連するデータセットに送信するので,レコードの集合を生成できます。
Params パラメータは,データパケットへとデータを取り出す前に,CommandText,問い合わせ,またはストアドプロシージャに適用されるすべてのパラメータ値を含みます。適切な場合,DoBeforeGetRecords は,これらの値を関連のデータセットに割り当てます。
OwnerData パラメータは,カスタム情報を BeforeGetRecords イベントハンドラに提供します。このイベントハンドラは,その値を変更できます。返された値は AfterGetRecords イベントハンドラに渡され,次に GetRecords メソッドの呼び出し側に返されます(オプション)。