PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget iOSApple WatchCatalystUniversal Windows 10 AppWindows Mobile
Autres
Procédures stockées
HDécritClé (Fonction)
En anglais : HDescribeKey
La fonction HDécritClé est conservée uniquement pour compatibilité (cette fonction sera encore supportée dans la prochaine version).
Depuis la version 8, pour décrire une clé, il faut :
  1. Déclarer un objet rubrique.
  2. Définir toutes les propriétés de la rubrique grâce aux propriétés HFSQL.
  3. Utiliser la fonction HDécritRubrique pour valider la création de la rubrique.
Voici la documentation de la fonction HDécritClé disponible avec WINDEV 5.5.
Remarque : A partir de la version 19, HFSQL est le nouveau nom de HyperFileSQL.
 
But
Décrire une clé simple ou composée dans un fichier de données temporaire au format Hyper File
Syntaxe
HDécritClé(<NomLogiqueFichierHF>,<NomRubriqueClé> [,<ListeRubriqueDeClé> [,<Doublon>]])
  • <NomLogiqueFichierHF> est une chaîne de caractères contenant le nom du fichier de données logique
  • <NomRubriqueClé> est une chaîne de caractères contenant le nom de la clé (100 caractères maximum)
  • <ListeRubriqueDeClé> est une chaîne de caractères optionnelle contenant la liste des rubriques composant la clé.
    • Pour une clé composée, dans <ListeRubriqueDeClé> chaque rubrique est séparée par une virgule : <NomRub1>, <NomRub2>, ...
    • Pour clé simple, <Liste Rubrique> contient le nom de la clé.
  • <Doublon> est un booléen optionnel permettant de savoir si la clé est unique ou multiple :
    • à Vrai si la clé est multiple (avec doublons)
    • à Faux si la clé est unique
    Par défaut, <Doublon> est à Vrai.
Détail
La clé est constituée en fonction des paramètres passés à HDécritClé.
Si <ListeRubriqueDeClé> n'est pas précisé, <NomRubriqueClé> doit être une rubrique du fichier de données
Si plusieurs clés sont décrites, les clés simples doivent être décrites avant les clés composées. Si une clé composée est décrite avant une clé simple, cela provoque une erreur HF 508.
Par défaut <Doublon> est à Vrai. Ainsi si <Doublon> n'est pas précisé, la clé sera multiple.
Notes
  • Le fichier de données doit avoir précédemment été décrit avec HDécritFichier.
  • La ou les rubriques composant la clé doivent avoir précédemment été décrites avec la fonction HDécritRubrique.
  • Pour décrire une clé simple unique, la syntaxe est la suivante :
    HDécritClé(<NomFic>, <Nom_Clé>, <Nom Clé> ,Faux)
  • La fonction HDécritClé ne peut pas être utilisée pour décrire une clé d'un fichier de données qui a été créé avec l'éditeur de description de fichier de données.
  • La fonction HDécritClé n'existe pas en langage externe.
  • La fonction HDécritClé ne doit pas être appelée après une des fonctions suivantes utilisée sur le même fichier de données : HOuvre, HCréation ou HCréationSiInexistant.
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire