Soap.SOAPDm.TSoapDataModule.GetRecords

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

Delphi

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

C++

System::OleVariant __fastcall GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData);

プロパティ

種類 可視性 ソース ユニット
function protected
Soap.SOAPDm.pas
Soap.SOAPDm.hpp
Soap.SOAPDm TSoapDataModule

説明

指定されたデータを格納したデータパケットを返します。

GetRecords は,(IAppServer インターフェースの)AS_GetRecords メソッドと,(IAppServerSOAP インターフェースの)SAS_GetRecords メソッドの基底の実装を提供します。GetRecords は,プロバイダのデータセットの現在のレコードを先頭に,要求されたレコードを返します。

  • ProviderName は,レコードの取り出し元となるプロバイダコンポーネントの名前を指定します。
  • Count は,取り出すレコードの数または種類を指定します。Count が -1 の場合,すべてのレコードを取り出します。Count が 0 の場合,メタデータだけを取り出します。Count が 0 より大きい場合は,Count の数だけのレコードを取り出します。
  • RecsOut は,取り出されたレコードの実際の数を返します。
  • Options は,データ以外にデータパケットに追加する情報を示します。これは GetRecordOption 定数の組み合わせです。
  • CommandText は,プロバイダの問い合わせの SQL を置換する SQL 文,またはプロバイダの基底データベーステーブルまたはストアドプロシージャを置換するテーブルまたはストアドプロシージャの名前を指定します。プロバイダの Options プロパティに poAllowCommandText が含まれない場合,このパラメータは無視されます。
  • Params は,プロバイダの実行によって要求されたデータを生成する前に,プロバイダのデータセットに渡すすべてのパラメータを格納するバリアントです。あらゆる出力パラメータを返します。
  • OwnerData は,クライアントデータセットの BeforeGetRecords イベントハンドラから渡されたカスタム情報を格納します。この情報は,プロバイダの BeforeGetRecords イベントハンドラに渡されます。OwnerData は,プロバイダの AfterGetRecords イベントハンドラから渡された情報を返します。
  • レコードは,データパケットとしてバリアントに格納されて返されます。

関連項目