Soap.SOAPMidas.IAppServerSOAP.SAS_GetRecords
Delphi
function SAS_GetRecords(const ProviderName: OleStr; Count: Integer; out RecsOut: Integer; Options: Integer; const CommandText: OleStr; var Params: OleVariant; var OwnerData: OleVariant): OleVariant; stdcall;
C++
virtual System::OleVariant __stdcall SAS_GetRecords(const System::WideString ProviderName, int Count, /* out */ int &RecsOut, int Options, const System::WideString CommandText, System::OleVariant &Params, System::OleVariant &OwnerData) = 0 ;
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | Soap.SOAPMidas.pas Soap.SOAPMidas.hpp |
Soap.SOAPMidas | IAppServerSOAP |
説明
指定されたデータを格納したデータパケットを返します。
SAS_SAS_GetRecords メソッドを呼び出すと,指定した数のレコードを取得できます。SAS_SAS_GetRecords は,プロバイダのデータセットの現在のレコードを先頭に,要求されたレコードを返します。SOAP データモジュールはステートレスなので,プロバイダの BeforeSAS_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 は,クライアントデータセットの BeforeSAS_GetRecords イベントハンドラから渡されたカスタム情報を格納します。この情報は,プロバイダの BeforeSAS_GetRecords イベントハンドラに渡されます。OwnerData は,プロバイダの AfterSAS_GetRecords イベントハンドラから渡された情報を返します。
レコードは,データパケットとしてバリアントに格納されて返されます。