HDécritRubrique (Fonction)

Comment décrire une rubrique par programmation ?
Liste des propriétés HFSQL utilisables pour décrire une rubrique par programmation
Syntaxe 2 : Description de rubrique temporaire au format Hyper File 5.5 (compatibilité)
Compatibilité

WINDEV

WEBDEV

WINDEV Mobile

Autres

Voir Aussi

HDécritRubrique (Fonction)

En anglais : HDescribeItem

Non disponible avec ce type de connexion

Décrit par programmation une rubrique d'un fichier de données.

Après l'appel à la fonction HDécritRubrique :

La rubrique peut être manipulée comme n'importe quelle rubrique décrite dans l'analyse.
La description de la rubrique ne peut plus être modifiée.
La variable de description de la rubrique est ré-initialisée. Une nouvelle description de rubrique peut être effectuée.

Versions 17 et supérieures

Cette fonction est désormais disponible pour les applications iPhone/iPad.

Nouveauté 17

Cette fonction est désormais disponible pour les applications iPhone/iPad.

Versions 18 et supérieures

Cette fonction est désormais disponible en mode Windows Store apps.

Nouveauté 18

Cette fonction est désormais disponible en mode Windows Store apps.

Versions 21 et supérieures

Cette fonction est désormais disponible en mode Universal Windows 10 App.

Nouveauté 21

Cette fonction est désormais disponible en mode Universal Windows 10 App.

Remarque : A partir de la version 19, HFSQL est le nouveau nom de HyperFileSQL.

Exemple

Voir des exemples supplémentaires

HDécritRubrique(ClientBis, NomClient)

Syntaxe

Description d'une rubrique dans un fichier de données créé par programmation Masquer les détails

<Résultat> = HDécritRubrique(<Fichier de données> , <Rubrique>)

<Résultat> : Booléen

Vrai si l'opération a été réalisée,
Faux en cas de problème. La fonction HErreurInfo permet d'identifier l'erreur.

<Fichier de données> : Variable de type Description de fichier

Nom de la variable de type Description de fichier correspondant au fichier de données dans lequel la rubrique doit être créée.

<Rubrique> : Variable de type Description de rubrique

Nom de la variable de type Description de Rubrique correspondant à la rubrique à créer.

Description d'une rubrique temporaire au format Hyper 5.5 (compatibilité uniquement) Masquer les détails

<Résultat> = HDécritRubrique(<Nom logique du fichier Hyper File 5.5> , <Description de la rubrique> [, <Dimension du tableau>])

<Résultat> : Booléen

Vrai si l'opération a été réalisée,
Faux en cas de problème. La fonction HErreurInfo permet d'identifier l'erreur.

<Nom logique du fichier Hyper File 5.5> : Chaîne de caractères

Nom du fichier de données temporaire au format Hyper File 5.5 décrit avec la fonction HDécritFichier (Syntaxe 2).

<Description de la rubrique> : Chaîne de caractères

Description de la rubrique de la forme <Nom Rubrique>,<Type Rubrique> (pas d'espace entre <Nom Rubrique> et <Type Rubrique>).
<Nom Rubrique> contient le nom de la rubrique
<Type Rubrique> contient le type de la rubrique et peut prendre pour valeur :
E : pour les rubriques de type entier
L : pour les rubriques de type entier long
C : pour les rubriques de type entier court
S : pour les rubriques de type réel simple
D : pour les rubriques de type réel double
A : pour les rubriques de type date sur 8 (AAAAMMJJ)
H : pour les rubriques de type heure HHMM
T,<Taille> : pour les rubriques de type texte (<Taille> est la taille de la chaîne de caractères)
M : pour les rubriques de type Mémo texte
O : pour les rubriques de type Mémo binaire
F : pour les rubriques de type monétaire

<Dimension du tableau> : Entier optionnel

Taille du tableau de rubriques.

Remarques

Comment décrire une rubrique par programmation ?

Pour décrire une rubrique par programmation, il faut :

Utiliser des variables de type Description de Fichier, Description de Rubrique et Description de Liaison (si nécessaire).
Décrire les caractéristiques du fichier de données, de ses rubriques et de ses liaisons grâce aux propriétés HFSQL.
Fixer la description des rubriques avec la fonction HDécritRubrique.
Fixer la description du fichier de données (fonction HDécritFichier) et des liaisons (fonction HDécritLiaison).

Liste des propriétés HFSQL utilisables pour décrire une rubrique par programmation

Les propriétés suivantes sont disponibles en lecture et écriture.


Composante	La propriété Composante permet de paramétrer les différentes composantes d'une clé composée.
FormuleClé	La propriété FormuleClé permet de paramétrer les différentes composantes d'une clé composée.
NbElémentTableau	La propriété NbElémentTableau permet de paramétrer le nombre d'éléments d'une rubrique tableau.
Nom	La propriété Nom permet de connaître : le nom de la police associée à une variable de type Police. le nom d'un champ, d'un état ou d'un bloc d'un état. le nom d'un champ, d'un groupe de champs ou d'une fenêtre. le nom d'un champ, d'un groupe de champs ou d'une page.
SensibleAccentuation	La propriété SensibleAccentuation permet de paramétrer la prise en compte de l'accentuation dans les différentes recherches effectuées sur la rubrique ou sur l'index full-text (avec les fonctions HLitRecherche, HLitRecherchePremier et HLitRechercheDernier par exemple).
SensibleCasse	La propriété SensibleCasse permet de paramétrer la prise en compte de la casse (majuscules/minuscules) dans les différentes recherches effectuées sur la rubrique ou sur l'index full-text (avec les fonctions HLitRecherche, HLitRecherchePremier et HLitRechercheDernier par exemple).
SensiblePonctuation	La propriété SensiblePonctuation permet de paramétrer la prise en compte de la ponctuation (virgule, point, etc.) dans les différentes recherches effectuées sur la rubrique (avec les fonctions HLitRecherche, HLitRecherchePremier et HLitRechercheDernier par exemple).
Taille	La propriété Taille permet de connaître et modifier la taille d'un élément.
Type	La propriété Type permet de connaître : le type d'un élément décrit par programmation (description de rubrique ou de fichier) ou non (fichier ou rubrique défini sous l'éditeur d'analyses, vue ou requête). le type d'un objet. le type de la valeur stockée dans un variant.
TypeClé	La propriété TypeClé permet de paramétrer les caractéristiques d'une rubrique clé.
TypeTri	La propriété TypeTri permet de : Connaître le sens de parcours défini pour une rubrique ou pour une composante d'une clé composée. Cette rubrique a été définie sous l'éditeur d'analyses ou par programmation. Définir le sens de parcours d'une rubrique ou d'une composante de clé composée (lors de la description de la rubrique par programmation uniquement).
ValeurParDéfaut	La propriété ValeurParDéfaut permet de : Connaître la valeur par défaut d'une rubrique. Cette rubrique a été définie sous l'éditeur d'analyses ou définie par programmation. Définir la valeur par défaut d'une rubrique (lors de la description de la rubrique par programmation uniquement).

Syntaxe 2 : Description de rubrique temporaire au format Hyper File 5.5 (compatibilité)

Cette syntaxe permet de créer des rubriques temporaires dans des fichiers de données temporaires au format Hyper File 5.5. Cette syntaxe n'est utilisable que dans une application réalisée avec WINDEV 5.5 ou WEBDEV 1.5 puis migrée vers la version 18. Pour utiliser cette fonction, il est nécessaire que :

l'analyse au format Hyper File 5.5 soit accessible sur le poste de développement.
le chemin de l'analyse Hyper File 5.5 soit spécifié dans les caractéristiques de l'analyse (onglet "Détail").

Compatibilité

Cette fonction remplace la fonction HDécritClé de WINDEV 5.5.

Composante : wd270hf.dll

Voir Aussi

Version minimum requise

Version 9

Documentation également disponible pour…

Commentaires

Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 19/04/2022

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