Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS_GetRecords
Delphi
function AS_GetRecords(const ProviderName: OleStr; Count: Integer; out RecsOut: Integer; Options: Integer; const CommandText: OleStr; ParamReader: TDBXStreamValue; OwnerDataStream: TDBXStreamValue): OleVariant;
C++
System::OleVariant __fastcall AS_GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, Data::Dbxcommon::TDBXStreamValue* ParamReader, Data::Dbxcommon::TDBXStreamValue* OwnerDataStream);
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | public | Datasnap.DSProviderDataModuleAdapter.pas Datasnap.DSProviderDataModuleAdapter.hpp |
Datasnap.DSProviderDataModuleAdapter | TDSProviderDataModuleAdapter |
説明
指定されたデータを格納したデータパケットを返します。
AS_GetRecords メソッドを呼び出すと、指定したレコードの数を取得できます。 AS_GetRecords はプロバイダのデータセットの現在のレコードを先頭に、要求されたレコードを返します。 ステートレスのリモートデータモジュールと一緒に使用する場合は、カーソルの再配置、またはプロバイダの BeforeGetRecords イベントハンドラでの 問い合わせやストアドプロシージャの再実行が必要になる場合があります。
ProviderName は、レコードを提供するプロバイダコンポーネントの名前を指定します。
Count は、取り出すレコードの数や種類を指定します。Count の値が -1 の場合、すべてのレコードを取り出します。Count の値が 0 の場合、メタデータだけを取り出します。 Count の値が 0 より大きい場合は、Count の数だけのレコードを取り出します。
RecsOut は、取り出されたレコードの実際の数を返します。
Options は、データに続いてデータパケットに追加する情報を示します。 これは、GetRecordOption 定数の組み合わせです。 たとえば、次の値は XML でコード化されたデータパケットとともにメタデータを要求します。
MetaDataOption + XMLOption
MetaDataOption || XMLOption
CommandText は、プロバイダの問い合わせの SQL を置き換えるオプションの SQL 文、またはプロバイダのテーブルやストアドプロシージャを置き換えるテーブルまたはストアドプロシージャをの名前を指定します。 Options プロパティに poAllowCommandText が含まれない場合、このパラメータは無視されます。
ParamReader は、プロバイダの実行によって要求されたデータを生成する前に、プロバイダのデータセットに渡すすべてのパラメータを格納するバリアントです。 その値はあらゆる出力パラメータを返します。 この引数で使用されるパラメータ Variant 形式と、グローバルの PackageParams ルーチンおよび UnpackParams ルーチンで 使用される TParams オブジェクトを相互に変換することができます。
OwnerDataStream は、クライアントデータセットの BeforeGetRecords イベントハンドラから渡されるカスタム情報を格納します。 この情報は、プロバイダの BeforeGetRecords イベントハンドラに渡されます。 OwnerDataStream は、プロバイダの AfterGetRecords イベントハンドラから渡された情報を返します。
レコードは、バリアント型のデータパケットとして (Delphi では戻り値として、C++ では AS_GetRecords _result パラメータとして)返されます。