Datasnap.Win.MtsRdm.TMtsDataModule.AS_GetRecords
Delphi
function AS_GetRecords(const ProviderName: WideString; Count: Integer;
out RecsOut: Integer; Options: Integer; const CommandText: WideString;
var Params, OwnerData: OleVariant): OleVariant; safecall;
C++
HIDESBASE 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.MtsRdm.pas Datasnap.Win.MtsRdm.hpp |
Datasnap.Win.MtsRdm | TMtsDataModule |
説明
指定されたデータを格納したデータパケットを返します。
Datasnap.Win.MtsRdm.TMtsDataModule.AS GetRecords は Datasnap.DataBkr.TRemoteDataModule.AS_GetRecords を継承しています。以下の内容はすべて Datasnap.DataBkr.TRemoteDataModule.AS_GetRecords を参照しています。
指定されたデータを格納したデータパケットを返します。
AS_AS_GetRecords メソッドを呼び出すと,指定した数のレコードを取得できます。AS_AS_GetRecords は,プロバイダのデータセットの現在のレコードを先頭に,要求されたレコードを返します。ステートレスのリモートデータモジュールと一緒に使用する場合は,カーソルの再配置,またはプロバイダの BeforeAS_GetRecords イベントハンドラでの問い合わせまたはストアドプロシージャの再実行が必要になる場合があります。
ProviderName は,レコードを提供するプロバイダコンポーネントの名前を指定します。
Count は,取り出すレコードの数または種類を指定します。Count が -1 の場合,すべてのレコードを取り出します。Count が 0 の場合,メタデータだけを取り出します。Count が 0 より大きい場合は,Count の数だけのレコードを取り出します。
RecsOut は,取り出されたレコードの実際の数を返します。
Options は,データ以外にデータパケットに追加する情報を示します。これは GetRecordOption 定数の組み合わせです。たとえば,次の値は,XML でコード化されたデータパケットとともにメタデータを要求します。
MetaDataOption + XMLOption MetaDataOption || XMLOption
CommandText は,プロバイダの問い合わせの SQL を置換する SQL 文,またはプロバイダの基底データベーステーブルまたはストアドプロシージャを置換するテーブルまたはストアドプロシージャの名前を指定します。プロバイダの Options プロパティに poAllowCommandText が含まれない場合,このパラメータは無視されます。
Params は,プロバイダの実行によって要求されたデータを生成する前に,プロバイダのデータセットに渡すすべてのパラメータを格納するバリアントです。あらゆる出力パラメータを返します。
OwnerData は,クライアントデータセットの BeforeAS_GetRecords イベントハンドラから渡されたカスタム情報を格納します。この情報は,プロバイダの BeforeAS_GetRecords イベントハンドラに渡されます。OwnerData は,プロバイダの AfterAS_GetRecords イベントハンドラから渡された情報を返します。
レコードはバリアント型パラメータである AS_GetRecords_result のデータパケットとして返されます。
メモ: アプリケーションは,IAppServer インターフェースを使用してのみプロテクトメソッド AS_AS_GetRecords を呼び出せます。アプリケーションサーバーからレコードをコードで直接取得するには,プロバイダコンポーネントの AS_GetRecords メソッドを使用します。