Afficher : Delphi C++
Préférences d'affichage

Datasnap.DBClient.TCustomClientDataSet.AddIndex

De RAD Studio API Documentation

Delphi

procedure AddIndex(const Name, Fields: string; Options: TIndexOptions;  const DescFields: string = ''; const CaseInsFields: string = ''; const GroupingLevel: Integer = 0);

C++

void __fastcall AddIndex(const System::UnicodeString Name, const System::UnicodeString Fields, Data::Db::TIndexOptions Options, const System::UnicodeString DescFields = System::UnicodeString(), const System::UnicodeString CaseInsFields = System::UnicodeString(), const int GroupingLevel = 0x0);

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
public
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Datasnap.DBClient TCustomClientDataSet

Description

Crée un nouvel index pour l'ensemble de données client.

La méthode AddIndex permet de créer un nouvel index pour l'ensemble de données client.

Name est le nom du nouvel index.

Fields est une liste, délimitée par des points-virgules, des champs à inclure dans l'index.

Options est un ensemble (éventuellement vide) qui peut contenir jusqu'à deux valeurs de TIndexOptions. Les valeurs autorisées dans cet ensemble sont : ixDescending (l'index trie en ordre alphanumérique décroissant) et ixCaseInsensitive (l'index ne tient pas compte des différences majuscules/minuscules dans le tri).

Avertissement :  AddIndex déclenche une exception si vous essayez de créer un index contenant d'autres valeurs de TIndexOptions.

DescFields est une liste de noms de champ délimités par des points-virgules. Utilisez DescFields à la place d'une valeur Options incluant ixDescending pour créer un indice qui trie en ordre croissant selon certains champs et en ordre décroissant selon d'autres. Tous les champs nommés dans DescFields sont triés en ordre décroissant.

CaseInsFields est une liste de noms de champs délimités par des points-virgules. Utilisez CaseInsFields au lieu d'une valeur de Options incluant ixCaseInsensitive pour créer un index ne tenant pas compte des différences majuscules/minuscules pour certains champs et en tenant compte pour d'autres. Tous les champs nommés dans CaseInsFields sont triés sans tenir compte des différences majuscules/minuscules.

GroupingLevel est le niveau de regroupement par défaut géré par l'index. Quand l'ensemble de données client utilise cet index, les informations de regroupement sont automatiquement disponibles pour les sous-groupes définis par jusqu'à GroupingLevel champs de l'indice. Si l'ensemble de données client utilise des agrégats mis à jour, il est possible de disposer d'informations sur un niveau plus important de regroupement quand les agrégats sont définis sur un niveau de regroupement supérieur à la valeur par défaut de l'indice. GroupingLevel peut être une valeur comprise entre 0 et le nombre de champs de l'index.

Remarque :  Les index ajoutés par AddIndex ne sont pas enregistrés avec les données par la méthode SaveToFile. Ils ne persistent pas lorsque l'ensemble de données client est fermé. (C'est à dire qu'ils sont perdus lorsque vous rouvrez l'ensemble de données client). Vous ne pouvez pas appeler AddIndex lorsque l'ensemble de données est fermé.
Conseil :  Vous pouvez gérer des agrégats mis à jour en utilisant un index ajouté avec AddIndex.

Voir aussi

Outils personnels
Traductions