Datasnap.Midas.IAppServer.AS_GetRecords

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function  AS_GetRecords(const ProviderName: OleStr; Count: Integer; out RecsOut: Integer;
Options: Integer; const CommandText: OleStr;
var Params: OleVariant; var OwnerData: OleVariant): OleVariant; safecall;

C++

virtual HRESULT __safecall AS_GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData, System::OleVariant &__AS_GetRecords_result) = 0 ;

プロパティ

種類 可視性 ソース ユニット
function public
Datasnap.Midas.pas
Datasnap.Midas.hpp
Datasnap.Midas IAppServer


説明

指定したデータを含むデータパケットを返します。

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 パラメータとして)、レコードを返します。

関連項目