Datasnap.Midas.IAppServerDisp.AS_GetRecords
Delphi
function AS_GetRecords(const ProviderName: OleStr; Count: Integer; out RecsOut: Integer; Options: Integer; const CommandText: OleStr; var Params: OleVariant; var OwnerData: OleVariant): OleVariant; dispid 20000001;
プロパティ
| 種類 | 可視性 | ソース | ユニット | 親 |
|---|---|---|---|---|
| function | automated | Datasnap.Midas.pas | Datasnap.Midas | IAppServerDisp |
説明
指定したデータを含むデータパケットを返します。
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 が含まれない場合、このパラメータは無視されます。
Params パラメータは、プロバイダの実行によって要求したデータを生成する前に、そのプロバイダのデータセットに渡されるすべてのパラメータを格納するバリアントです。 このパラメータは、あらゆる出力パラメータを返します。この引数に使用されるパラメータのバリアント形式と、グローバルな PackageParams と UnpackParams ルーチンを使用する TParams オブジェクトは相互に変換が可能です。
OwnerData パラメータは、クライアント データセットの BeforeGetRecords イベント ハンドラに渡されるカスタム情報を含みます。 この情報は、プロバイダの BeforeGetRecords イベント ハンドラに渡されます。 OwnerData は、プロバイダの AfterGetRecords イベント ハンドラに渡される情報を返します。
バリアントのデータパケットとして（Delphi では戻り値、C++ では AS_GetRecords _result パラメータとして）、レコードを返します。