Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS GetRecordsのソースを表示

{{DISPLAYTITLE:Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS_GetRecords}}{{#lst:API:Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS GetRecords|api}}

<!--Start API Documentation-->
==説明==
{{#ifeq: {{PAGENAME}} | Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS GetRecords | |{{InheritsFrom|Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS_GetRecords}}}}

<section begin=short />指定されたデータを格納したデータパケットを返します。<section end=short />

[[Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS GetRecords|AS_GetRecords]] メソッドを呼び出すと、指定したレコードの数を取得できます。 [[Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS GetRecords|AS_GetRecords]] はプロバイダのデータセットの現在のレコードを先頭に、要求されたレコードを返します。 ステートレスのリモートデータモジュールと一緒に使用する場合は、カーソルの再配置、またはプロバイダの [[Datasnap.Provider.TCustomProvider.BeforeGetRecords|BeforeGetRecords]] イベントハンドラでの 問い合わせやストアドプロシージャの再実行が必要になる場合があります。 

ProviderName は、レコードを提供するプロバイダコンポーネントの名前を指定します。

Count は、取り出すレコードの数や種類を指定します。Count の値が -1 の場合、すべてのレコードを取り出します。Count の値が 0 の場合、メタデータだけを取り出します。 Count の値が 0 より大きい場合は、Count の数だけのレコードを取り出します。

RecsOut は、取り出されたレコードの実際の数を返します。

Options は、データに続いてデータパケットに追加する情報を示します。 これは、GetRecordOption 定数の組み合わせです。 たとえば、次の値は XML でコード化されたデータパケットとともにメタデータを要求します。




<source lang="delphi">


MetaDataOption + XMLOption


</source>





<source lang="cpp">


MetaDataOption || XMLOption


</source>




CommandText は、プロバイダの問い合わせの SQL を置き換えるオプションの SQL 文、またはプロバイダのテーブルやストアドプロシージャを置き換えるテーブルまたはストアドプロシージャをの名前を指定します。 [[Datasnap.Provider.TBaseProvider.Options|Options]] プロパティに poAllowCommandText が含まれない場合、このパラメータは無視されます。 

ParamReader は、プロバイダの実行によって要求されたデータを生成する前に、プロバイダのデータセットに渡すすべてのパラメータを格納するバリアントです。 その値はあらゆる出力パラメータを返します。 この引数で使用されるパラメータ Variant 形式と、グローバルの [[Datasnap.DBClient.PackageParams|PackageParams]] ルーチンおよび [[Datasnap.DBClient.UnpackParams|UnpackParams]] ルーチンで 使用される [[Data.DB.TParams|TParams]] オブジェクトを相互に変換することができます。 

OwnerDataStream は、クライアントデータセットの [[Datasnap.Provider.TCustomProvider.BeforeGetRecords|BeforeGetRecords]] イベントハンドラから渡されるカスタム情報を格納します。 この情報は、プロバイダの [[Datasnap.Provider.TCustomProvider.BeforeGetRecords|BeforeGetRecords]] イベントハンドラに渡されます。 OwnerDataStream は、プロバイダの [[Datasnap.Provider.TCustomProvider.AfterGetRecords|AfterGetRecords]] イベントハンドラから渡された情報を返します。 

レコードは、バリアント型のデータパケットとして (Delphi では戻り値として、C++ では [[Datasnap.DSProviderDataModuleAdapter.TDSProviderDataModuleAdapter.AS GetRecords|AS_GetRecords]] _result パラメータとして)返されます。 

===関連項目===

* [[Datasnap.DBClient.TCustomClientDataSet.Data|Data]]

* [[Datasnap.DBClient.TCustomClientDataSet.Params|Params]]

* [[Datasnap.DBClient.TCustomClientDataSet.GetNextPacket|GetNextPacket]]

* [[Datasnap.Provider.TCustomProvider.GetRecords|GetRecords]]

* [[Datasnap.DBClient.TCustomClientDataSet.BeforeGetRecords|BeforeGetRecords]]

* [[Datasnap.Provider.TCustomProvider.BeforeGetRecords|BeforeGetRecords]]

* [[Datasnap.Provider.TCustomProvider.AfterGetRecords|AfterGetRecords]]

* [[Datasnap.Provider.TBaseProvider.Options|Options]]

* [[Datasnap.DBClient.PackageParams|PackageParams]]

* [[Datasnap.DBClient.UnpackParams|UnpackParams]]

* [[rad_ja:クライアント データセットとの通信|クライアント データセットとの通信]]


[[Category:API ドキュメント]]
<!--End API Documentation-->