Fonction script : Indique la valeur d'un objet Variable. |
GET_VAR(Variable [, [ Clef ] [, Colonne] ])
Elément de syntaxe |
Description/format |
---|---|
Variable |
Nom d'une Variable dont les valeurs doivent être lues. |
Clé |
Lignes de valeur |
Colonne |
Numéro de la colonne dont les valeurs doivent être utilisées. Valeurs autorisées : |
Codes retour |
---|
Valeur/s de la Variable |
Les valeurs peuvent être lues avec le script tant à partir d'objets de Variables statiques que dynamiques. Lors de l'accès aux Variables dynamiques, une résolution s'effectue, ainsi la valeur est déterminée directement par la source de données (base de données, variable, répertoire).
Si pour une quelconque raison, une erreur survient lors de la résolution d'objets de Variables dynamiques, cela entraîne une erreur de durée d'exécution!
Si le paramètre Clef n'est pas indiqué, la première ligne est automatiquement utilisée. Pour les objets de Variables statiques dont le domaine de validité est défini comme "Index libre", il faut toutefois toujours indiquer une Clef!
S la colonne manque, la colonne Valeur 1 (pour les objets Variable statiques) utilise automatiquement la colonne résultats (Source de Variables : SQL, SQL interne, Multi) ou la colonne Liste fichiers (Source de Variables : liste de fichiers).
Pour les Variables dont la source Liste de fichiers, soit il faut omettre la colonne ou bien utiliser la valeur "1". Comme il n'existe qu'une colonne, la Clef indiquée comprend la valeur retournée.
Comme valeur pour colonne le domaine de 1 (première colonne de valeur) au dernier numéro de colonne de la Variable est autorisé. Attention: les Variables statiques possèdent au maximum 5 colonnes de valeur. Pour lire la colonne Clef (Variables statiques) ou la colonne de résultats (Variables dynamiques hormis la "Liste de fichiers", il faut utiliser les valeurs "KEY" ou "RESULT" pour colonne. Si le script est utilisé en relation avec :FILL et qu'aucune colonne n'est indiquée, toutes les valeurs de la ligne de Variables sont enregistrées dans le tableau de script.
Le format de la valeur correspond au format de sortie qui est défini par l'onglet Attributs.
La fonction de script permet également de lire les variables de l'Agent.
Pour accéder à une Clef qui commence par le caractère &, il faut indiquer deux fois ce caractère. Sinon, cette expression est interprétée comme une Variable de script et essaie de la résoudre.
Exemple: Accès à la clef "&clef" dans l'objet Variable VARA.TEST
:SET &TEST# = GET_VAR(VARA.TEST,"&&clef")
Pour les Variables dynamiques, la valeur de la colonne résultat (Paramètre Clef) est indiquée dans le format qui définit la valeur dans la source de données (base de données SQL, objet Variable MULTI). Le format de sortie de la variable ne joue aucun rôle dans le processus!
L'exemple détermine la valeur d'une Variable et la transmet à une Variable de script.
:SET &TEST# = GET_VAR(GS_FIN, "Jour d'écriture")
On peut également utiliser une Variable de script au sein de la fonction.
:SET &VAR# = "GS_FIN"
:SET &GUELT# = "Jour d'écriture"
:SET &TEST# = GET_VAR(&VAR#, &GUELT#)
Dans cet exemple, la fonction est utilisée pour formuler une condition.
:IF GET_VAR(GS_FIN, "JOUR D'ECRITURE") = SYS_DATE("JJMMAA")
!...
:ENDIF
Rubriques connexes :
Elément de script | Description |
---|---|
:DELETE_VAR | Supprime une ou toutes les valeurs d'un objet Variable statique. |
:PUT_VAR | Enregistre les valeurs dans un objet Variable statique. |
:SET_SCRIPT_VAR | Définit les valeurs des Variables de script par accès indirect. |
GET_SCRIPT_VAR | Indique les valeurs des Variables de script par accès indirect. |
PREP_PROCESS_VAR | Prépare le traitement d'une séquence de données (valeurs d'un objet Variable). |
Elément de script - Lecture ou modification d'objets
Exemples :
Maintenance de la base de données avec options
Exécution d'un MBean
Généralités sur les scripts
Elément de script - Liste alphabétique
Elément de script - Division fonctionnelle