Data.DB.IProviderSupport.PSGetIndexDefs

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

Delphi

function PSGetIndexDefs(IndexTypes: TIndexOptions = [ixPrimary..ixNonMaintained]): TIndexDefs;

C++

virtual TIndexDefs* __fastcall PSGetIndexDefs _DEPRECATED_ATTRIBUTE0 (TIndexOptions IndexTypes = (TIndexOptions() << TIndexOption::ixPrimary << TIndexOption::ixUnique << TIndexOption::ixDescending << TIndexOption::ixCaseInsensitive << TIndexOption::ixExpression << TIndexOption::ixNonMaintained )) = 0 ;

プロパティ

種類 可視性 ソース ユニット
function public
Data.DB.pas
Data.DB.hpp
Data.DB IProviderSupport


説明

警告: PSGetIndexDefs は非推奨になっています。 IProviderSupportNG を使用してください。

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

プロバイダ コンポーネントは、PSGetIndexDefs を呼び出し、必要な情報を格納するインデックスを探します。たとえば、PSGetIndexDefs を使用して、PSGetKeyFields が返したキー フィールドを持つインデックスを探します。この情報により、プロバイダは、更新適用時に変更する必要のあるレコードを検索することができます。プロバイダはまた、このメソッドを呼び出し、データ パケットのメタデータに追加したインデックスを検索します。

IndexTypes は、返されたインデックスの必須オプションを示します。PSGetIndexDefs は、指定されたフラグを含む Options プロパティを持つ、すべてのインデックスを返します。


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

関連項目