Data.DB.IProviderSupport.PSGetIndexDefs

De RAD Studio API Documentation
Aller à : navigation, rechercher

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 ;

Propriétés

Type Visibilité  Source Unité  Parent
function public
Data.DB.pas
Data.DB.hpp
Data.DB IProviderSupport


Description

Avertissement : PSGetIndexDefs est obsolète. Veuillez utiliser IProviderSupportNG.

Renvoie la définition de tous les index spécifiés définis dans l'ensemble de données.

Le composant fournisseur appelle PSGetIndexDefs pour trouver un index qui contient les informations dont il a besoin. Par exemple, il utilise PSGetIndexDefs pour trouver un index contenant les champs clés renvoyés par PSGetKeyFields. Cette information permet au fournisseur de trouver les enregistrements qui ont besoin d'être modifiés quand il applique les mises à jour. Le fournisseur appelle également cette méthode pour trouver les index qu'il ajoute aux métadonnées des paquets de données.

IndexTypes indique les options attendues dans les index renvoyés. PSGetIndexDefs renvoie tous les index dont la propriété Options contient les indicateurs spécifiés.

PSGetIndexDefs renvoie un objet TIndexDefs qui contient tous les index de l'ensemble de données qui correspondent au paramètre IndexTypes.

Voir aussi