GAM-CTX
BUT
Cette fonction permet de piloter le contexte des variables contextuelles gammes (VGG : variables des étapes gammes) en identifiant le nom de ces variables sous la forme de variables et en permettant de récupérer le type de la variable, sa valeur ou d’initialiser sa valeur.
Cette fonction est disponible uniquement pour les requêtes de type GCC et ne concerne que les variables contextuelles gammes.
TYPE
CARACTERE (rubrique fonction (libellé : Gestion Ctx Variable)).
SYNTAXE
Variable = GAM-CTX ( ACTION = REC-TYPE,REC-VALEUR,MAJ-VALEUR
TYPE-VARIABLE = VGG
NOM-VARIABLE = Référence de la variable traitée
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-VALEUR : cette action demande à DIAPASON de donner la valeur de la variable définie dans le paramètre NOM-VARIABLE. La valeur est retournée dans la variable du paramètre entrée-sortie VALEUR. MAJ-VALEUR : cette action demande à DIAPASON de mettre à jour la valeur de la variable définie dans le paramètre NOM-VARIABLE. La valeur est définie dans la variable du paramètre entrée-sortie VALEUR |
TYPE-VARIABLE | E | Oui | Caractère | Type DIAPASON de variable. La valeur n’est pas saisissable et doit contenir VGG. |
NOM-VARIABLE | E | Oui | Caractère | Nom de la variable VGG à définir sous la forme de variable ou de constante ; le nom de cette variable doit correspondre au nom d’une variable VGG disponible dans le contexte d’’exécution de la requête. |
VALEUR | E | 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 VGG dont le nom est le contenu de la variable locale Ressource :
VLO.Fct = GAM-CTX( ACTION= REC-VALEUR , TYPE-VARIABLE=VGG , NOM-VARIABLE= VLO.Ressource, E-S:VALEUR= VLO.Valeur )
NOTES
La fonction retourne dans la variable résultat la valeur *INC lors de toute anomalie d’exécution et la valeur vide pour toute exécution correcte.