INI-VAR-APP : Initialisation de Variables « Objets Applicatifs »
BUT
Permet de gérer la valeur d’une variable (standard ou spécifiques « VOP ») d’un objet paramétrable dans le cadre d’une requête REB exécutée comme règle de gestion sur un objet paramétrable DIAPASON.
TYPE
CARACTERE
La variable retour de la fonction contient le résultat d’exécution de la fonction (vide : OK, non vide : problème).
SYNTAXE
Resultat_Fonction = INI-VAR-APP( ACTION= REC-TYPE,LEC-VALEUR,MAJ-VALEUR
ENTITE = Référence_Entité
VARIABLE = Référence_Variable
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 VARIABLE pour l’objet paramétrable donné dans le paramètre ENTITE. Le type est retourné dans la variable du paramètre entrée-sortie VALEUR. LEC-VALEUR : cette action demande à DIAPASON de lire la valeur de la variable définie dans le paramètre VARIABLE pour l’objet paramétrable donné dans le paramètre ENTITE. 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 VARIABLE pour l’objet paramétrable donné dans le paramètre ENTITE. La valeur est définie dans la variable du paramètre entrée-sortie VALEUR |
ENTITE | E | Oui | Caractère | Référence objet paramétrable. Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou par la sélection de l’objet paramétrable (liste proposée). |
VARIABLE | E | Oui | Caractère | Référence variable. Cette référence peut être donnée par une variable locale, une constante globale, une constante locale ou par la sélection d’une variable de l’objet paramétrable précédemment sélectionné (la liste des variables est proposée si un objet paramétrable a été précisé auparavant). |
VALEUR | E-S | Oui | Caractère | Variable dont le comportement dépend de l’action : Action REC-TYPE : après exécution de la fonction, contient le type de la variable définie dans le paramètre VARIABLE pour l’objet paramétrable donné dans le paramètre ENTITE. Action LEC-VALEUR : après exécution de la fonction, contient la dernière valeur affectée par la dernière action MAJ-VALEUR à la variable définie dans le paramètre VARIABLE pour l’obet paramétrable donné dans le paramètre ENTITE (voir notes ci-dessous). Action MAJ-VALEUR : avant exécution de la fonction, contient la valeur que va affecter la fonction à la variable définie dans le paramètre VARIABLE pour l’objet paramétrable donné dans le paramètre ENTITE (voir notes ci-dessous). |
Cette fonction retourne dans la variable retour le résultat de l’exécution de la fonction (vide : exécution OK, non vide : problème).
EXEMPLE
La première utilisation de la fonction permet de récupérer la valeur de la variable standard « DesiUniMes » pour l’unité de mesure courante
La seconde utilisation permet d’affecter à la variable standard « DesiUniMes » de l’unité de mesure courante, la désignation récupérée précédemment avec le suffixe « _H »
La troisième utilisation permet de récupérer la valeur de la variable spécifique « TisVn » pour l’unité de mesure courante
La quatrième utilisation permet d’affecter à la variable spécifique « TisVn » de l’unité de mesure courante, la valeur récupérée précédemment augmentée de 1,1.
NOTES
Cette fonction est effectivement utilisée par DIAPASON exclusivement lors de l’exécution dans une requête REB comme règle de gestion sur une action standard (création, duplication, modification, suppression) ; le principe est le suivant : lors de l’exécution de la requête dans le contexte de l’objet paramétrable géré, DIAPASON mémorise les valeurs affectées à l’objet paramétrable en cours de gestion via l’utilisation de l’action MAJ-VALEUR ; à la fin de l’exécution de la requête, DIAPASON affecte effectivement les variables de l’objet paramétrable géré avec les valeurs initialisées via l’action MAJ-VALEUR.
L’action LEC-VALEUR permet de récupérer la valeur qui sera affectée à la variable correspondante de l’objet paramétrable courant à la fin de l’exécution ; elle ne correspond pas à la valeur de la variable connue contextuellement sur l’objet paramétrable en début ou en cours d’exécution de la requête REB.
La variable retour contient *INC si la fonction ne s’est pas exécutée correctement (variable inexistante par exemple). Dans le cas de l’action LEC-VALEUR, si la variable est bien définie mais n’a pas de valeur, le code retour de la fonction est *NO-DEF.
Cette fonction permet de mettre à jour les variables spécifiques comme les variables standard de l’entité.