LEC-CTX-ENT
BUT
Cette fonction permet de récupérer le contexte (type, format, valeur) de certaines variables de bases d’une entité configurée (article standard, ligne de commande commerciale) en passant les clés de l’entité et en identifiant le nom de ces variables sous la forme de variables. Cette fonction permet de lire des variables dans n’importe quel contexte de l’entité configurée.
Cette fonction est disponible dans tous les types de requêtes.
TYPE
CARACTERE (rubrique fonction gestion ; libellé : Lecture Contexte)).
SYNTAXE
Variable = LEC-CTX-ENT ( ACTION = REC-TYPE,REC-FORMAT,REC-VALEUR,REC-VAL/HER
TYPE=Entité
CLE 1 ENTITE = Clé-1_Entité,
CLE 2 ENTITE = Clé-2_Entité,
CLE 3 ENTITE= Clé-3_Entité,
REF-CONTEXTE=Contexte
TYPE-VARIABLE = VBA (non saisi)
NOM-VARIABLE = Référence de la variable VBA traitée
S :VALEUR = valeur liée à l’action de la fonction)
PARAMETRES
Paramètre | E/S | O | Type | Description |
ACTION | E | Oui | Caractère | 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 NOM-VARIABLE. Le type est retourné dans la variable du paramètre entrée-sortie VALEUR. REC-FORMAT : cette action demande à DIAPASON de donner le format de la variable définie dans le paramètre NOM-VARIABLE. Le format est retourné dans la variable du paramètre entrée-sortie VALEUR. LISTE-CONTEXTE : cette action demande à DIAPASON de donner la liste des contextes commerciaux pour l’entité demandée. Cette liste est retournée dans la variable du paramètre entrée-sortie VALEUR. LISTE-NIVEAUX : cette action demande à DIAPASON de donner la liste des niveaux des contextes commerciaux pour l’entité demandée. Cette liste est retournée dans la variable du paramètre entrée-sortie VALEUR. REC-VALEUR : cette action demande à DIAPASON de rechercher la valeur de la variable VBA définie dans le paramètre NOM-VARIABLE. La valeur est retourné dans la variable du paramètre entrée-sortie VALEUR. La valeur est recherchée exclusivement dans le contexte donné dans le paramètre REF-CONTEXTE. REC-VAL/HER : cette action demande à DIAPASON de rechercher par héritage la valeur de la variable VBA définie dans le paramètre NOM-VARIABLE. La valeur est retourné dans la variable du paramètre entrée-sortie VALEUR. La valeur est recherchée dans le contexte donné dans le paramètre REF-CONTEXTE et dans les références contextes supérieures de l’arborescence des contextes en partant de ce contexte origine (voir fonction LEC-CTX). |
TYPE | E | Oui | Caractère | Référence entité correspondant à la clé donnée de recherche. Cette référence peut être donnée par la valeur fixe ART.STD (Article), LIG.CDE (Ligne de Commande Commerciale), une variable locale, une constante globale, une constante locale ou par la sélection de variables selon le type de requête. Remarque : ce paramètre n’est pas utilisé pour les actions REC-TYPE et REC-FORMAT. |
CLE 1 ENTITE | E | Oui | Caractère | Clé de niveau 1 de l’entité correspondant à la clé donnée de recherche. Cette clé peut être donnée par une variable locale, une constante globale, une constante locale ou par la valeur d’une variable contextuelle (la définition de ce niveau de clé correspond à la définition du même niveau de clé de la fonction ENR-ACT-ENT). Remarque : ce paramètre n’est pas utilisé pour les actions REC-TYPE et REC-FORMAT. |
CLE 2 ENTITE | E | Oui | Caractère | Clé de niveau 2 de l’entité correspondant à la clé donnée de recherche. Cette clé peut être donnée par une variable locale, une constante globale, une constante locale ou par la valeur d’une variable contextuelle (la définition de ce niveau de clé correspond à la définition du même niveau de clé de la fonction ENR-ACT-ENT). Remarque : ce paramètre n’est pas utilisé pour les actions REC-TYPE et REC-FORMAT. |
CLE 3 ENTITE | E | Oui | Caractère | Clé de niveau 3 de l’entité correspondant à la clé donnée de recherche. Cette clé peut être donnée par une variable locale, une constante globale, une constante locale ou par la valeur d’une variable contextuelle (la définition de ce niveau de clé correspond à la définition du même niveau de clé de la fonction ENR-ACT-ENT). Remarque : ce paramètre n’est pas utilisé pour les actions REC-TYPE et REC-FORMAT. |
REF-CONTEXTE | E | Oui | Caractère | Référence contexte de définition de l’entité. Donné sous la forme de variable ou de constante. Obligatoire dans le cas d’une définition multi-contexte. Si cette variable contient la valeur vide, DIAPASON sélectionne par défaut le contexte de niveau le plus haut. |
TYPE-VARIABLE | E | Oui | Caractère | Type DIAPASON de variable. Non saisi, forcé à VBA |
NOM-VARIABLE | E | Oui | Caractère | Nom de la variable VBA dans le dictionnaire des variables DIAPASON. |
VALEUR | S | Oui | Caractère | Valeur en entrée ou sortie de fonction dépendant du paramètre ACTION. |
EXEMPLE
L’instruction qui suit permet de mémoriser dans la variable locale Valeur la valeur
effective (au format caractère exclusivement) de la variable VBA dont le nom est le contenu de la variable locale Nom et dont le contexte est le contenu de la variable locale Contexte pour la ligne de commande 0607000001/001 :
VLO.Fct = LEC-CTX-ENT( ACTION= REC-VALEUR , TYPE=LIG.CDE , CLE 1 ENTITE=CLO."0607000001" , CLE 2 ENTITE=CLO." 001" , CLE 3 ENTITE=CLO." " , REF-CONTEXTE = VLO.Contexte , TYPE-VARIABLE=VBA , NOM-VARIABLE= VLO.Nom , E-S:VALEUR= VLO.Valeur )
NOTES
La fonction retourne dans la variable résultat la valeur *INC lors de toute anomalie d’exécution (notamment lorsque la variable n’a pas été trouvée) et la valeur vide pour toute exécution correcte.
Le principe de fonctionnement dans le cas d’une arborescence de contexte est le même que la fonction LEC-CTX.