|
|
|
|
|
|
|
|
|
|
- Gestion automatique des clés composées
- Filtre et parcours filtré
- Activation/désactivation d'un filtre
- Fichiers de données non HFSQL
<Source>.FiltreComprisEntre (Fonction) En anglais : <Source>.FilterIncludedBetween
 Non disponible avec ce type de connexion
Définit et active un filtre de type "Compris entre" sur un fichier de données, une vue ou une requête. Le filtre de type "Compris Entre" permet de sélectionner tous les enregistrements compris entre deux valeurs données. Après son exécution, les cas suivants sont les plus fréquents : - le filtre ne peut pas être créé : la fonction <Source>.FiltreComprisEntre renvoie une chaîne vide (""). La fonction HErreur permet de récupérer l'identifiant de l'erreur.
- le filtre est créé : la fonction <Source>.FiltreComprisEntre renvoie la clé de parcours optimale à utiliser pour réaliser le parcours du fichier de données, de la vue ou de la requête.
MaCléParcours est une chaîne
MaCléParcours = Client.FiltreComprisEntre(NomPrénom, ...
"A", "B" + hValMax, hSéparateurBorne, "C", "D" + hValMax)
// Sélection de tous les clients dont le nom est compris entre A et C
// et dont le prénom est compris entre C et D
Client.LitPremier(MaCléParcours)
TANTQUE PAS Client.EnDehors()
Trace(Client.NomClient, Client.Ville)
Client.LitSuivant(MaCléParcours)
FIN
...
// Désactive le filtre
Client.DésactiveFiltre() Syntaxe
<Résultat> = <Source>.FiltreComprisEntre(<Rubrique clé> , <Borne min de la composante 1 de la clé> [, <Borne min de la composante 2 de la clé> [... [, <Borne min de la composante N de la clé>]]] , <hSéparateurBorne> , <Borne max de la composante 1 de la clé> [, <Borne max de la composante 2 de la clé> [... [, <Borne min de la composante N de la clé>]]])
<Résultat> : Chaîne de caractères Rubrique de parcours. Correspond :- soit à la clé de parcours du fichier de données si le filtre est activé.
- soit à une chaîne vide ("") si le filtre ne peut pas être mis en place.
<Source> : Type correspondant à la source spécifiée Nom du fichier de données, de la vue ou de la requête manipulé. <Rubrique clé> : Chaîne de caractères Nom de la rubrique clé sur laquelle le filtre doit être réalisé. Cette rubrique peut être une clé simple de type chaîne ou une clé composée.
Attention : ce paramètre ne doit contenir que des lettres, des caractères soulignés ou des chiffres. Dans le cas contraire, il faut entourer le nom de guillemets. <Borne min de la composante 1 de la clé> : Type de la première composante de la clé de parcours Borne minimale pour la première (respectivement deuxième, ...) composante de la clé composée. Les enregistrements correspondant à cette valeur sont inclus dans le filtre.
Le type de ce paramètre doit correspondre au type de la composante de la rubrique clé sur laquelle le filtre est défini. <Borne min de la composante 2 de la clé> : Type de la seconde composante de la clé de parcours Borne minimale pour la seconde composante de la clé composée. Les enregistrements correspondant à cette valeur sont inclus dans le filtre.
Le type de ce paramètre doit correspondre au type de la composante de la rubrique clé sur laquelle le filtre est défini. <Borne min de la composante N de la clé> : Type de la nième composante de la clé de parcours Borne minimale pour la nième composante de la clé composée. Les enregistrements correspondant à cette valeur sont inclus dans le filtre.
Le type de ce paramètre doit correspondre au type de la composante de la rubrique clé sur laquelle le filtre est défini. <hSéparateurBorne> : Constante de type Entier La constante hSéparateurBorne permet de séparer les valeurs des bornes minimales et maximales pour les composantes de la clé composée. <Borne max de la composante 1 de la clé> : Type de la première composante de la clé de parcours Borne maximale pour la première (respectivement deuxième, ...) composante de la clé composée. Les enregistrements correspondant à cette valeur sont inclus dans le filtre.
Le type de ce paramètre doit correspondre au type de la composante de la rubrique clé sur laquelle le filtre est défini. <Borne max de la composante 2 de la clé> : Type de la seconde composante de la clé de parcours Borne maximale pour la seconde composante de la clé composée. Les enregistrements correspondant à cette valeur sont inclus dans le filtre.
Le type de ce paramètre doit correspondre au type de la composante de la rubrique clé sur laquelle le filtre est défini. <Borne min de la composante N de la clé> : Type de la nième composante de la clé de parcours Borne minimale pour la nième composante de la clé composée. Les enregistrements correspondant à cette valeur sont inclus dans le filtre.
Le type de ce paramètre doit correspondre au type de la composante de la rubrique clé sur laquelle le filtre est défini. Remarques Gestion automatique des clés composées La fonction <Source>.FiltreComprisEntre gère automatiquement les filtres sur les clés simples comme sur les clés composées. Exemple : Utilisation de la fonction <Source>.FiltreComprisEntre avec une clé simple :
RésultatFiltre = Client.FiltreComprisEntre(Nom, "A", hSéparateurBorne, "B" + hValMax)
// Sélection de tous les clients dont le nom est compris entre A et C Exemple : Utilisation de la fonction <Source>.FiltreComprisEntre avec une clé composée
RésultatFiltre = Client.FiltreComprisEntre(NomPrénom, "A", "B" + hValMax, ...
hSéparateurBorne, "C", "D" + hValMax)
// Sélection de tous les clients dont le nom est compris entre A et C
// et dont le prénom est compris entre C et D Cette ligne de code est équivalente à :
Client.Filtre(NomPrénom, ...
Client.ConstruitValClé(NomPrénom, "A", "B" + hValMin), ...
Client.ConstruitValClé(NomPrénom, "C", "D" + hValMax)) Filtre et parcours filtré Après l'exécution de la fonction <Source>.FiltreComprisEntre, le parcours du fichier de données doit obligatoirement être effectué sur la rubrique renvoyée par la fonction <Source>.FiltreComprisEntre. Si une autre rubrique est utilisée pour le parcours du fichier de données, le filtre ne sera pas pris en compte. Lorsqu'un filtre est défini et activé sur un fichier de données (une vue ou une requête), tout enregistrement lu correspond au filtre. Si il n'y a plus d'enregistrement correspondant au filtre lors du parcours : - la fonction <Source>.EnDehors renvoie Vrai.
- l'enregistrement en cours correspond au dernier enregistrement lu avec le filtre.
Par exemple : Activation/désactivation d'un filtre - La fonction <Source>.DésactiveFiltre permet de désactiver un filtre.
- La fonction <Source>.ActiveFiltre permet de ré-activer un filtre.
- Lorsque le fichier de données (la requête ou la vue) est fermé (fonction <Source>.Ferme par exemple), le filtre est supprimé.
- A un même instant, il ne peut exister qu'un seul filtre sur un fichier de données (une requête ou une vue). Si la fonction <Source>.FiltreComprisEntre est utilisée plusieurs fois, seul le dernier filtre sera pris en compte : le(s) filtre(s) précédent(s) seront supprimés. De même si plusieurs filtres sont utilisés (fonctions HFiltre*), seul le dernier filtre sera pris en compte.
Documentation également disponible pour…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|