Data.SqlExpr.TCustomSQLDataSet.PSGetIndexDefs

提供:RAD Studio API Documentation

Delphi

function PSGetIndexDefs(IndexTypes: TIndexOptions): TIndexDefs; override;

C++

virtual Data::Db::TIndexDefs* __fastcall PSGetIndexDefs(Data::Db::TIndexOptions IndexTypes);

プロパティ

種類 可視性 ソース ユニット
function protected
Data.SqlExpr.pas
Data.SqlExpr.hpp
Data.SqlExpr TCustomSQLDataSet

説明

データセットに対して定義されている、指定されたすべてのインデックスの定義を返します。 {{#multireplace:Data.SqlExpr.TCustomSQLDataSet.PSGetIndexDefs|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}} は {{#multireplace:Data.DB.TDataSet.PSGetIndexDefs|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}} を継承しています。以下の内容はすべて {{#multireplace:Data.DB.TDataSet.PSGetIndexDefs|H21=!|H25=%|H28=(|H29=)|H2A=*|H2B=+|H2F=/|H3C=<|H3D==|H3E=>|H5B=[|H5D=]|H5E=^|H7C=|}} を参照しています。

データセットに対して定義されている、指定されたすべてのインデックスの定義を返します。

プロバイダ コンポーネントは PSGetIndexDefs を呼び出し、必要な情報を持っているインデックスを検索します。たとえば、PSGetIndexDefs を使用して、PSGetKeyFields によって返されたキー フィールドを持っているインデックスを検索します。この情報により、プロバイダは、更新をかける際に変更の必要な記録を探すことが可能になります。 また、プロバイダはこのメソッドを呼び出し、データ パケットのメタデータに追加するインデックスを検索します。

IndexTypes には、インデックスを返すために必要なオプションを指定します。PSGetIndexDefs は、指定されたフラグが Options プロパティにある、すべてのインデックスを返します。

PSGetIndexDefs は、IndexTypes パラメータと一致する、データセットの全インデックスを保持する、TIndexDefs オブジェクトを返します。

このメソッドは IProviderSupport.PSGetIndexDefs メソッドの実装で、デフォルトでは、nil(Delphi の場合)および NULL(C++ の場合)を返します。これは、TDataSet がデフォルトではプロバイダを実装していないためです。 使用するには、TDataSet の子孫はそれぞれ独自に、これをオーバーライドしなければなりません。

関連項目