LEC-SCECFG
BUT
Cette fonction permet d’accéder à la valeur d’une variable d’un scénario de configuration 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 contexte, …).
Cette fonction est liée à l’utilisation de l’instruction PA-SCECFG qui permet de se positionner sur un contexte d’un scénario de configuration et de l’instruction PA-IT-SCECFG qui permet de parcourir les informations techniques d’un contexte.
Cette fonction est disponible uniquement dans les requêtes de type REB.
SYNTAXE
VLO.Resultat_Fonction = LEC-SCECFG
( ACTION = DEFINITION / RESET / TYPE / RECHERCHE VALEUR / CONTEXTE
VARIABLE= Réf.Variable,
VALEUR= Valeur)
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-SCECFG qui permet de parcourir le scénario de configuration. 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 contexte courant du scénario de configuration parcouru par l’instruction PA-SCECFG. La valeur est retournée dans la variable du paramètre VALEUR. CONTEXTE: cette action permet de retourner dans le paramètre VALEUR la référence du contexte courant parcouru par l’instruction PA-SCECFG. |
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. |
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. CONTEXTE : retourne la valeur de la référence du contexte en cours de parcours dans l’itération de l’instruction PA-SCECFG. |
EXEMPLE
Voir exemple instruction PA-SCECFG.
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
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-SCECFG.
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-SCECFG 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 contexte courant, DIAPASON recherche la variable dans les contextes 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-SCECFG 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, di-t-valnu1, di-t-valnu2, di-t-valnu3.
Dans le cas d’un scénario mono-contexte, l’option CONTEXTE retourne une valeur vide.