QOP-ENV

BUT

Cette fonction permet de retourner des caractéristiques sur l’utilisation des questionnaires optionnels dans un scénario de configuration.

Cette fonction peut être utilisée dans les requêtes de type GCA, GCL, REN, RN1 et RN5.

TYPE CARACTERE (rubrique fonction gestion).

SYNTAXE

Variable = QOP-ENV( CONTEXTE=Contexte

, VARIABLE_VBA = Variable

, S :RESULTAT = Résultat)

PARAMETRES

Paramètre	E/S	O	Type	Description
CONTEXTE	E	Oui	Caractère	Ce paramètre permet d’identifier le contexte traité par la fonction. Il peut avoir pour valeur le paramètre *TOUS (indique que tous les contextes vont être parcourus) ou indiquer un contexte particulier du scénario (donné sous la forme d’une variable locale, d’une variable contextuelle, d’une constante globale ou d’une constante locale)
VARIABLE_VBA	E	Oui	Caractère	Ce paramètre permet d’identifier la référence de la variable de type VBA sur laquelle est potentiellement rattaché un questionnaire optionnel. Il peut avoir pour valeur le paramètre *TOUS (indique que toutes les variables vont être parcourues) ou indiquer une variable particulière du scénario (donné sous la forme d’une variable locale, d’une variable contextuelle, d’une constante globale ou d’une valeur donnée parmi toutes les VBAs existant dans le dictionnaire)
S :RESULTAT	S	Oui	Caractère	Donne le résultat de la fonction (voir le résultat suivant les paramètres donnés en entrée)

EXEMPLE

VLO.Fonction = QOP-ENV( CONTEXTE= *TOUS , VARIABLE_VBA= *TOUS , S:RESULTAT= VLO.Liste_Contexte_QOP )

Cette instruction retourne dans la variable Liste_Contexte_QOP la liste chainée (séparateur caractère virgule (,)) de tous les contextes pour lesquels un questionnaire optionnel est défini pour le scénario de configuration courant. Chaque référence du contexte du questionnaire optionnel est sous la forme d’une chaine de caractère composée de la référence du contexte de lancement du questionnaire optionnel + : + la référence de la question sur laquelle est lancé le questionnaire optionnel.

Si aucun questionnaire optionnel n’est défini pour le scénario, la variable Liste_Contexte_QOP est vide (= CLO.« »).

VLO.Fonction = QOP-ENV( CONTEXTE= VLO.Contexte , VARIABLE_VBA= *TOUS , S:RESULTAT= VLO.Liste_Variables_QOP )

Cette instruction retourne dans la variable Liste_Variables_QOP la liste chainée (séparateur caractère virgule (,)) de toutes les variables du questionnaire du contexte identifié par la variable VLO.Contexte sur lesquelles un questionnaire optionnel est rattaché.

Si aucun questionnaire optionnel n’est défini pour le contexte parcouru, la variable Liste_Variables_QOP est vide (= CLO.« »).

VLO.Fonction = QOP-ENV( CONTEXTE= *TOUS , VARIABLE_VBA= VLO.Question, S:RESULTAT= VLO.Liste_Contextes)

Cette instruction retourne dans la variable Liste_Contextes la liste chainée (séparateur caractère virgule (,)) de tous les contextes du scénario courant pour lesquels un questionnaire optionnel à la question dont la référence est identifiée par la variable VLO.Question.

Si aucun questionnaire optionnel n’est défini pour la question recherchée dans le scénario, la variable Liste_Contextes est vide (= CLO.« »).

Si le contexte donné n’est pas défini, la fonction retourne une erreur avec la valeur '*ERR: Contexte inconnu’.

VLO.Fonction = QOP-ENV( CONTEXTE= VLO.Contexte, VARIABLE_VBA= VLO.Question, S:RESULTAT= VLO.Question_QOP)

Cette instruction retourne dans la variable Question_QOP la référence de la question si un questionnaire optionnel est défini pour le contexte identifié par la variable VL.Contexte et la question identifiée par la variable Question (la valeur de la variable Question_QOP est égale à la variable Question).

Si le questionnaire optionnel n’est pas défini pour le contexte et la question donnés du scénario, la fonction retourne une erreur avec la valeur ‘*ERR: Pas de questionnaire optionnel rattaché’.

Si le contexte donné n’est pas défini, la fonction retourne une erreur avec la valeur '*ERR: Contexte inconnu’.

NOTES

La fonction retourne dans la variable résultat la valeur *INC lors de toute anomalie d’exécution. Les autres cas d’erreurs sont décrits dans la partie exemple.
Dans le cas d’une requête de type GCQ, cette fonction retourne les caractéristiques des questionnaires optionnels au moment du démarrage de la requête. Si dans la requête, les caractéristiques des questionnaires optionnels du contexte courant évoluent, la fonction ne retournera pas les nouvelles caractéristiques ; il faut dans ce cas utiliser le contenu de la variable SCR.CtxSelLOp qui maintient la liste des questions du contexte courant sur lesquelles un questionnaire optionnel est effectivement défini au fur et à mesure du déroulement du questionnaire courant (voir fonction QOP-DEROULE).