Datasnap.Provider.TCustomProvider.DoBeforeGetRecords
Delphi
procedure DoBeforeGetRecords(Count: Integer; Options: Integer;
const CommandText: OleStr; var Params, OwnerData: OleVariant); virtual;
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 | TCustomProvider |
説明
BeforeGetRecords イベントを生成します。
GetRecords メソッドは，データを取り出したり，データをデータパケットにアセンブルする前に DoBeforeGetRecords を呼び出して BeforeGetRecords イベントを生成します。
Count パラメータは，要求されたレコードの数です。Count が -1 の場合，すべてのレコードが要求されます。
Options パラメータは，データパケットにメタデータを含むかどうか，最初のレコードから開始するかどうか，およびデータパケットを XML でコード化するかどうかを示します。詳細は，GetRecords メソッドを参照してください。
CommandText パラメータは，関連する問い合わせの SQL を置換するオプションの SQL 文，または関連するテーブルや関連するプロシージャを置換するテーブルまたはストアドプロシージャの名前を指定します。このパラメータは，Options プロパティが poAllowCommandText を含まない場合，またはプロバイダに Options プロパティがない場合には無視されます。
Params パラメータは，データパケットへとデータを取り出す前に，CommandText，問い合わせ，またはストアドプロシージャに適用されるすべてのパラメータ値を含みます。
OwnerData パラメータは，カスタム情報を BeforeGetRecords イベントハンドラに提供します。このイベントハンドラは，その値を変更できます。返された値は AfterGetRecords イベントハンドラに渡され，次に GetRecords メソッドの呼び出し側に返されます（オプション）。
TCustomProvider クラスで実装される Count，Options，CommandText，および Params は無視されます。下位クラスは，BeforeExecute イベントを生成する前にこれらの値を適用します。