|
VADELIA |
SADELIA |
|
MADELIA |
(I/B) (C/S) |
(B) (S) |
(I) (C/S) |
Attention : cet ordre n'est utilisable dans un programme batch que pour le mode *VARMSG.
Paragraphe d'utilisation
Tous
Syntaxe
ENVOYER_MSG NumMsgOuIdVarAlpha SuiteParamètres Mode
ENVOYER_MSG *EFF_TOUT
ENVOYER_MSG *EFF_ANCIEN
NumMsgOuIdVarAlpha |
→ | NumMsg | &IdVarAlpha |
Mode |
→ |
*BOITE(Bouton, IdVarRéponse RangBtnDft) |
| *BOITE(*OK) |
||
| *VARMSG(VarMsg) |
||
| Rien |
Bouton |
→ |
*OK_ANNUL |
| *ABAND_REP_IGN |
||
| *OUI_NON_ANNUL |
||
| *OUI_NON |
||
| *REP_ANNUL |
||
RangBtnDft |
→ |
, 1 | , 2 | , 3 | Rien |
VarMsg |
→ |
IdVarMsgNiveau1 | IdVarMsgNiveau1 , IdVarMsgNiveau2 |
Description
Hors du mode *VARMSG, cet ordre affiche un message dans une boîte de message au milieu de l'écran. Cette boîte est bloquante ou non suivant le mode Mode précisé.
L'identificateur du message NumMsg est défini sur 4 caractères (numéro du message) ou sur 7 caractères (préfixe + numéro du message).
La variable IdVarAlpha doit être de type ALPHA(7) et doit contenir le nom complet du message (préfixe + numéro du message).
Des paramètres (identificateurs de variables de l'environnement de données) peuvent être indiqués si le message a été défini avec des paramètres.
Si le mode est *BOITE, la boîte bloque l'application jusqu'à ce que l'utilisateur clique sur un bouton. Le mode *BOITE est interdit dans les blocs serveurs. Si *BOITE n'est pas indiqué, les messages sont envoyés dans une boîte Adélia affichant la liste des messages.
Le type de bouton Bouton permet de spécifier le nombre et le type des boutons à afficher :
*OK |
bouton OK uniquement |
*OK_ANNUL |
boutons OK et Annuler |
*ABAND_REP_IGN |
boutons Abandonner, Réessayer et Ignorer |
*OUI_NON_ANNUL |
boutons Oui, Non et Annuler |
*OUI_NON |
boutons Oui et Non |
*REP_ANNUL |
boutons Réessayer et Annuler |
Lorsque *OK est choisi, on n'indique pas de variable IdVarRéponse ni de valeur RangBtnDft .
La variable IdVarRéponse (variable numérique) récupère le code retour de la boîte de message, c'est-à-dire le bouton choisi par l'utilisateur. Voici les valeurs possibles :
Valeur |
Bouton cliqué |
*BTN_OK |
bouton OK |
*BTN_ANNUL |
bouton Annuler |
*BTN_ABAND |
bouton Abandonner |
*BTN_REP |
bouton Réessayer |
*BTN_IGN |
bouton Ignorer |
*BTN_OUI |
bouton Oui |
*BTN_NON |
bouton Non |
La valeur RangBtnDft détermine le rang du bouton qui possède le focus par défaut à l'ouverture de la boîte. Il part de la gauche vers la droite.
Si le mode *VARMSG est précisé, le message n'est pas affiché, mais le message de niveau 1 est placé dans la variable alphanumérique IdVarMsgNiveau1, et le message de niveau 2 est placé dans la variable alphanumérique IdVarMsgNiveau2, si elle est indiquée. Lorsque le mode *VARMSG est utilisé dans une partie serveur, le fichier des messages d'erreur correspondant à la plate-forme serveur devra être présent dans le contexte serveur. De plus, pour les parties serveur Windows et Java si on veut utiliser un message d'une langue donnée il faut avoir fixé la langue serveur via la fonction VaToolBxSetServerLanguage, alors que pour une partie serveur AS/400 on prendra le premier fichier des messages d'erreur ayant le bon nom se trouvant dans la liste des bibliothèques et donc il faudra mettre en premier celui de la langue voulue.
Si le mode *VARMSG est précisé, le mot réservé *CODE_RETOUR est mis à jour, permettant de détecter si le fichier des messages d'erreur n'a pas été trouvé, ou que l'identifiant du message n'existe pas (dans le cas d'un appel dynamique par exemple : ENVOYER_MSG &MonAlpha7DuMessage..)
L'instruction permet également de remettre à blanc la liste des messages en passant *EFF_TOUT pour tout effacer, ou *EFF_ANCIEN pour effacer seulement les messages qui ont déjà été affichés à l'utilisateur.
Par exemple
ENVOYER_MSG MSG0001 ZCODECLI *BOITE(*OK_ANNUL, BOUTON)
SI BOUTON = *BTN_ANNUL
ENVOYER_MSG MSG0002 *BOITE(*OUI_NON, BOUTON, 1)
...
FIN
ENVOYER_MSG MSG0002 *BOITE(*OK)
ENVOYER_MSG MSG0003 PARAM1
ENVOYER_MSG MSG0003 PARAM1 *VARMSG(VARMSG1)
ENVOYER_MSG MSG0004 *BOITE(*OUI_NON, ResuMsg, 2)
* Fait afficher un message de confirmation avant suppression d'un enregistrement
* Le bouton NON, de rang 2, est le bouton par défaut de la boîte d'affichage
SI (ResuMsg = *BTN_OUI)
* ResuMsg est une variable numérique retournant le bouton choisi
SUPPRIMER_SQL CLIENT *COND(CSIR_CLI = :ZNUM_CLI)
SI *SQLCODE = *NORMAL
VALIDER_MAJ
FIN
FIN
ALPHAVAR = 'MSG0002'
ENVOYER_MSG &ALPHAVAR
* avec ALPHAVAR déclaré comme ALPHA(7)