LEC-NOMDEF
BUT
Cette fonction permet soit :
D’accéder à la valeur d’une variable d’un pointeur de toute nomenclature en identifiant le nom de la variable sous forme de variable ou de constante ; d’autres options permettent de gérer d’autres informations (définition des variables à utiliser, récupération des informations techniques d’un pointeur, …)
De déterminer s’il existe des propriétés calculées pour un couple domaine/groupe sur un pointeur de toute nomenclature.
Cette fonction est liée à l’utilisation de l’instruction PA-NOMDEF qui permet de se positionner sur un pointeur d’une nomenclature de définition et des instructions :
PA-IT-NOMDEF qui permet de parcourir les informations techniques d’un pointeur
PA-PR-NOMDEF qui permet de parcourir les propriétés d’un pointeur.
Cette fonction est disponible uniquement dans les requêtes de type REB.
SYNTAXE
Cas accès à une variable d’un pointeur :
VLO.Resultat_Fonction = LEC-NOMDEF
( ACTION = DEFINITION / RESET / TYPE / RECHERCHE VALEUR / POINTEUR /
STATUT NIVEAU
VARIABLE= Réf.Variable,
VALEUR= Valeur)
Cas détermination existence de propriétés pour un pointeur :
VLO.Resultat_Fonction = LEC-NOMDEF
(ACTION = EXI-PROP
DOMAINE = Réf.Domaine,
GROUPE = Réf. Groupe ou Tous)
PARAMETRES
Paramètre | E/S | O | Type | Description |
ACTION | E | Oui | Caractère | Les valeurs possibles sont : DEFINITION : cette action permet de déclarer les noms de variables pouvant être utilisées par la suite dans l’action de recherche de valeur de variable. Cette action doit impérativement être effectuée avant l’instruction PA-NOMDEF qui permet de parcourir la nomenclature de pointeur. RESET : cette action permet d’annuler toutes les déclarations de variables précédemment effectuées par l’action DEFINITION. REC-TYPE : cette action demande à DIAPASON de donner le type (Caractère, Numérique, Date, Logique) de la variable définie dans le paramètre VARIABLE. Le type est retourné dans la variable du paramètre VALEUR. REC-VALEUR : cette action demande à DIAPASON de donner la valeur de la variable définie dans le paramètre VARIABLE du pointeur courant parcouru par l’instruction PA-NOMDEF. La valeur est retournée dans la variable du paramètre VALEUR. POINTEUR : cette action permet de retourner dans le paramètre VALEUR la référence du pointeur courant parcouru par l’instruction PA-NOMDEF. STA-NIV : cette action permet de retourner dans une variable retour caractère donnée en paramètre des informations sur le contexte du niveau de nomenclature de pointeur parcouru dans la boucle de parcours de la nomenclature; les valeurs possibles sont : P s'il s'agit du premier pointeur, D s'il s'agit du dernier pointeur, B s'il s'agit d'un pointeur de dernier niveau (ou niveau le plus bas), I s'il s'agit d'un pointeur intermdédiaire EXI-PROP : cette action permet déterminer s’il existe des propriétés calculées pour un couple domaine/groupe donné |
Variable | E | Oui | Caractère | Option devant être renseignée pour les actions DEFINITION et REC-VALEUR. ACTION=DEFINITION : cette option contient le nom de la variable ou une liste chaînée des noms de variables pour lesquelles une valeur va être recherchée dans une ou des instructions suivantes (avec l’option REC-VALEUR). Le nom peut être donné sous la forme d’une variable (locale ou contextuelle) ou constante ou sous la forme d’une sélection d’un nom de variable VBA. ACTION=REC-VALEUR : cette option permet de donner le nom de la variable VBA pour laquelle une recherche de valeur sera retournée dans l’option VALEUR. Le nom peut être donné sous la forme d’une variable (locale ou contextuelle) ou constante ou sous la forme d’une sélection d’un nom de variable VBA. |
Domaine | E | Oui | Caractère | Option devant être renseignée pour l’action EXI-PROP. Elle contient la référence du domaine pour lequel on recherche les propriétés. |
Groupe | E | Oui | Caractère | Option devant être renseignée pour l’action EXI-PROP. Elle contient la référence du groupe lié au domaine ci-dessus, pour lequel on recherche les propriétés. |
Erreur | E | Oui | Caractère | Nom de la variable locale qui va contenir le retour de l’action exécutée : ACTION=DEFINITION : retourne la liste chaînée de tous les noms de variables définies. ACTION=RESET : retourne la liste chaînée de tous les noms de variables précédemment définies. ACTION=REC-TYPE : retourne le type de la variable dont le nom est passé dans l’option VARIABLE. REC-VALEUR : retourne la valeur de la variable dont le nom est passé dans l’option VARIABLE. POINTEUR : retourne la valeur de la référence du pointeur en cours de parcours dans l’itération de l’instruction PA-NOMDEF. |
Paramètre | E/S | O | Type | Description |
EXEMPLE
VLO.erreur = LEC-NOMDEF( ACTION= REC-VALEUR ,
TYPE-VARIABLE=VBA,
NOM -VARIABLE= di_prop_ref,
S:VALEUR= VLO.reference )
Voir exemple instruction PA-NOMDEF
NOTES
La fonction retourne dans la variable résultat (Resultat_Fonction) la valeur vide si l’exécution s’est correctement déroulée ; dans tous les autres cas, une valeur non vide indique le code erreur explicite de l’erreur. Les valeurs possibles sont les suivantes :
*ERR:CTX-LVA-INC : contexte liste variables incohérent
*ERR:VAR-NON-HER : variable non héritée
*ERR:VAR-DEF : variable déjà définie
*ERR:VAR-NON-EXI : variable inex. ou tabl.
*ERR:VAR-IND : variable indéfinie ou vide
*ERR:DEF-VAR-IMP : définition variable impossible
*ERR:CTX-INC : contexte reset variables incohérent
*ERR:VAR-INC : variable inconnue
*ERR:VAR-INC : variable inconnue
*ERR:CTX-ITs-INC : contexte d'ITs incohérent
*ERR:VAR-NON-DEF : valeur variable non définie
*ERR:CTX-VAR-INC : contexte rech.var. incohérent
*ERR:CTX-REC-INC : contexte de recherche incohérent
*ERR:CTX-EXE-INC : contexte d'exécution incohérent
*ERR:CTX-NON-POS : contexte propriété non positionné
*ERR:PRO-NON-EXI : Pas de propriétés pour le domaine et groupe
Avant d’utiliser l’action de recherche de valeur (REC-VALEUR), il faut impérativement déclarer les variables faisant l’objet de recherche avec l’action DEFINITION ; cette action doit être déclarée en dehors d’un bloc itératif de l’instruction PA-NOMDEF.
L’utilisation de l’action de recherche de valeur (REC-VALEUR) doit impérativement se trouver à l’intérieur d’un bloc itératif de l’instruction PA-NOMDEF pour récupérer une valeur d’une variable de base (VBA) ; la valeur de la variable est retournée via le principe d’héritage (si la variable n’est pas définie localement au pointeur, DIAPASON recherche la variable dans les pointeurs supérieurs de l’arborescence de la nomenclature).
L’utilisation de l’action de recherche de valeur (REC-VALEUR) doit impérativement se trouver à l’intérieur d’un bloc itératif de l’instruction PA-IT-NOMDEF pour récupérer une valeur d’une information technique; le nom de la variable (option VARIABLE) peut être di-t-type, di-t-sstype, di-t-code, di-t-valeur.
L’utilisation de l’action de recherche de valeur (REC-VALEUR) doit impérativement se trouver à l’intérieur d’un bloc itératif de l’instruction PA-PR-NOMDEF pour récupérer une valeur d’une propriété; le nom de la variable (option VARIABLE) peut être :
di_prop_dom donne la référence du domaine
di_prop_grp donne la référence du groupe
di_prop_ref donne la référence de la propriété
di_prop_ord donne le numéro d'ordre de la propriété
di_prop_val donne la valeur de la propriété
di_prop_typ donne le type de la propriété.
di_prop_arb donne l’arborescence qui a menée à la propriété