DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / WLangage / Gestion des bases de données / HFSQL / Fonctions HFSQL
  • Affichage du résultat dans un champ Liste ou Combo
  • Extraire une information du résultat
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
Renvoie la liste des clés d'un fichier de données (d'une requête ou d'une vue) reconnu par le moteur HFSQL. Il est possible de savoir :
  • le type de la clé,
  • sa taille,
  • si la clé est unique ou avec doublons, ...
Les fichiers définis par les fonctions <Source>.Déclare, <Source>.DéclareExterne et <Source>.DécritFichier sont pris en compte.
Exemple
// Récupérer les clés d'un fichier de données présent dans l'analyse en cours
ListeCle est une chaîne
ListeCle = Client.ListeClé(hLstDétail)
// Ajoute la liste des clés dans COMBO_COMBO1
COMBO_COMBO1.Ajoute(ListeCle)
Syntaxe
<Résultat> = <Source>.ListeClé([<Chemin du WDD> [, <Mot de passe du WDD> [, <Options>]]])
<Résultat> : Chaîne de caractères
Liste des clés présentes dans le fichier de données spécifié. Les différentes descriptions de chaque clé sont séparées par RC (Retour chariot). Les clés listées sont triées en fonction de l'ordre physique des clés dans le fichier de données (sauf si la constante hLstTriée est utilisée).
En fonction de la constante utilisée, le résultat est plus ou moins détaillé :
hLstDétail non précisé<Nom de la clé 1> + RC + <Nom de la clé 2 + RC + ...
Le résultat avec les constantes hLstClé et/ou hLstCléComposée et/ou hLstTriée est identique.
hLstDétail précisé<Nom de la clé 1> + TAB + <Type> + TAB+ <Taille> + TAB + <Formule> + TAB + <Unique> + TAB + <Libellé> + RC + ...
hLstDétailPlus<Nom de la clé 1> + TAB + <Type> + TAB + <Taille> + TAB + <Formule> + TAB + <Unique> + TAB + <Libellé> + TAB + <Partie entière des clés numériques> + TAB + <Partie décimale des clés numériques> + RC + ...
Où :
  • <Nom de clé X> : nom de la clé.
  • <Type> : type de la clé : "T" pour texte (et monétaire) ou "N" pour numérique.
  • <Taille> : taille de la rubrique.
  • <Formule> : formule de la clé si la clé est composée (si la clé est simple, seul le nom de la clé est retourné).
  • <Unique> :
    • "2" pour les clés primaires.
    • "1" pour une clé unique,
    • "0" pour une clé avec doublons.
  • <Libellé> : libellé de la clé.
  • <Partie entière des clés numériques> : nombre de chiffres de la partie entière des clés numériques.
  • <Partie décimale des clés numériques> : nombre de chiffres de la partie décimale des clés numériques.
<Source> : Type correspondant à la source spécifiée
Nom du fichier de données (de la requête ou de la vue) dont les clés doivent être listées.
Si un nom de requête est spécifié, cette requête doit être en cours d'exécution (fonctions <Source>.ExécuteRequête ou <Source>.ExécuteRequêteSQL) pour que la fonction <Source>.ListeClé fonctionne. Dans le cas contraire, une erreur du WLangage est générée.
<Chemin du WDD> : Chaîne de caractères optionnelle
Chemin complet de l'analyse (c'est-à-dire du fichier .WDD) dans laquelle le fichier de données est décrit.
Si ce paramètre n'est pas précisé ou est égal à une chaîne vide (""), le fichier de données est recherché dans l'analyse en cours.
<Mot de passe du WDD> : Chaîne de caractères optionnelle
Mot de passe défini pour l'analyse.
Si aucun mot de passe n'est défini, ce paramètre doit être égal à une chaîne vide ("").
<Options> : Constante ou combinaison de constantes de type entier (optionnel)
Type de liste à effectuer :
hLstCléListe les rubriques clés (clés non composées uniquement).
Hyper File 5.5 Cette constante n'est pas prise en compte.
hLstCléComposéeListe les rubriques clés composées uniquement.
Hyper File 5.5 Cette constante n'est pas prise en compte.
hLstDétailInformations détaillées (idem WINDEV 5.5).
hLstDétailPlusPour les clés numériques, ajoute le nombre de chiffres de la partie entière et de la partie décimale.
Hyper File 5.5 Cette constante n'est pas prise en compte.
hLstNormal
(valeur par défaut)
Correspond à hLstTout. Valeur utilisée par défaut si les constantes hLstClé, hLstCléComposée et hLstTout ne sont pas utilisées.
hLstOrdreLogiqueTrie la liste dans l'ordre logique des rubriques (ignorée si la constante hLstTriée est précisée).
Hyper File 5.5 Cette constante n'est pas prise en compte.
hLstRubriqueOrigineUtilisée sur un fichier journal (xxxJNL.fic), liste les clés du fichier de données original (qui a été journalé). Par exemple, sur le fichier ClientJNL.Fic, liste les rubriques clés du fichier CLIENT.
Hyper File 5.5 Cette constante n'est pas prise en compte.
hLstToutListe toutes les clés (hLstClé + hLstCléComposée).
Hyper File 5.5 Cette constante n'est pas prise en compte.
hLstTriéeTrie la liste par ordre croissant.
Hyper File 5.5 Cette constante n'est pas prise en compte.
Remarques

Affichage du résultat dans un champ Liste ou Combo

<Résultat> peut être directement affecté à un champ Liste ou Combo grâce à la fonction <Liste>.Ajoute. Chaque ligne contiendra le nom d'une des clés trouvées.

Extraire une information du résultat

Pour extraire une information du résultat détaillé, il est conseillé d'utiliser la fonction <Type Chaîne>.ExtraitChaîne.
Composante : wd290hf.dll
Version minimum requise
  • Version 25
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 20/06/2023

Signaler une erreur ou faire une suggestion | Aide en ligne locale