Datasnap.Win.TConnect.TLocalConnection.AS_GetRecords

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


Delphi

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

C++

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);

プロパティ

種類 可視性 ソース ユニット
function protected
Datasnap.Win.TConnect.pas
Datasnap.Win.TConnect.hpp
Datasnap.Win.TConnect TLocalConnection

説明

指定されたデータを保持しているデータ パケットを返します。

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 は、バリアント型で、プロバイダのデータセットが、要求されたデータの生成を実行する前に渡される必要がある、パラメータを保持しています。 これは、出力パラメータを返します。 この引数で使用されるパラメータ用のバリアント形式と、TParams オブジェクト型の間では、グローバルの PackageParams および UnpackParams ルーチンを使用して、変換することができます。

OwnerData は、クライアント データセットの BeforeGetRecords イベント ハンドラによって供給される、独自の情報を保持しています。 この情報は、プロバイダの BeforeGetRecords イベント ハンドラへ渡されます。 そして、OwnerData は、プロバイダの AfterGetRecords イベント ハンドラによって供給される情報を返します。

レコードは、バリアント型のデータ パケットとして返されます(Delphi では戻り値として、C++ では AS_GetRecords_result パラメータとして)。

関連項目