Datasnap.Provider.TCustomProvider.InternalGetRecords
Delphi
function InternalGetRecords(Count: Integer; out RecsOut: Integer;
Options: TGetRecordOptions; const CommandText: OleStr;
var Params: OleVariant): OleVariant; virtual;
C++
virtual System::OleVariant __fastcall InternalGetRecords(int Count, /* out */ int &RecsOut, TGetRecordOptions Options, const System::WideString CommandText, System::OleVariant &Params);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | protected | Datasnap.Provider.pas Datasnap.Provider.hpp |
Datasnap.Provider | TCustomProvider |
説明
GetRecords メソッドの基底実装を提供します。
GetRecords メソッドは，DoBeforeGetRecords を呼び出して CommandText および Params を適用し，BeforeGetRecords イベントを生成した後に，InternalGetRecords を呼び出してデータパケットをアセンブルします。TCustomProvider では，IInternalGetRecords は常に NULL を返します。下位クラスは，このメソッドをオーバーライドして，要求されたレコードをフェッチし，それをデータパケットにアセンブルします。
Count は，取り出すレコードの数を示します。Count が -1 の場合，すべてのレコードを取り出します。Count が 0 の場合，メタデータだけを取り出します。Count を 1 以上に設定すると，指定された数のレコードだけが取り出されます。
RecsOut は，取り出されたレコードの実際の数を返します。
Options は，データ以外にデータパケットに追加する情報を示します。Options は，grMetaData（メタデータを含む），grReset（データセットの最初のレコードから提供する），および grXML（OleVariant ではなく XML としてデータパケットをコード化する）または grXMLUTF8（拡張文字が UTF8 でエンコードされることを除いて，grXML と同じ）を含むことができます。
CommandText パラメータは，関連する問い合わせの SQL を置換するオプションの SQL 文，または関連するテーブルや関連するプロシージャを置換するテーブルまたはストアドプロシージャの名前を指定します。このパラメータは，Options プロパティが poAllowCommandText を含まない場合，またはプロバイダに Options プロパティがない場合には無視されます。
Params パラメータは，CommandText または関連する問い合わせやストアドプロシージャに適用するパラメータ値を指定します。プロバイダが TTable オブジェクトに関連付けられている場合，Params は，結果セットにフィルタをかける項目値を指定します。GetRecords を終了する際，Params はすべての出力パラメータを返します。
レコードは，データパケットとしてバリアントに格納されて返されます。