API:Data.SqlExpr.TCustomSQLDataSet.PSGetIndexDefs

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

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

C++

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

Propriétés

Type Visibilité  Source Unité  Parent
function protected
Data.SqlExpr.pas
Data.SqlExpr.hpp
Data.SqlExpr TCustomSQLDataSet

Description

Renvoie les définitions de tous les index spécifiés définis pour l'ensemble de données.

Data.SqlExpr.TCustomSQLDataSet.PSGetIndexDefs hérite de Data.DB.TDataSet.PSGetIndexDefs. Tout le contenu en-dessous de cette ligne se réfère à Data.DB.TDataSet.PSGetIndexDefs.

Renvoie les définitions de tous les index spécifiés définis pour 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.

Cette méthode est une implémentation de la méthode IProviderSupport.PSGetIndexDefs. Elle renvoie nil pour Delphi et NULL pour C++, car TDataSet n'implémente pas un fournisseur par défaut. Pour l’utiliser, chaque descendant de TDataSet doit la redéfinir d'une manière spécifique.

Voir aussi