MsgBox, fonction

Microsoft VBScript

Microsoft® Visual Basic® Scripting Edition MsgBox, fonction Référence du langage 
Version 1 


Description
Affiche un message dans une boîte de dialogue, attend que l'utilisateur clique sur un bouton et renvoie une valeur indiquant le bouton choisi par l'utilisateur.
Syntaxe
MsgBox(prompt[, buttons][, title][, helpfile, context])

La syntaxe de la fonction MsgBox comprend les arguments suivants:

élément Description
prompt Expression de chaîne qui est affichée sous la forme d'un message dans la boîte de dialogue. La longueur maximum de l'argument prompt est environ 1024 caractères, selon la largeur des caractères utilisés. Si l'argument prompt se compose de plusieurs lignes, vous pouvez les séparer en utilisant un caractère de retour chariot (Chr(13)), un caractère de retour à la ligne (Chr(10)) ou une combinaison de ces deux caractères (Chr(13) & Chr(10)).
buttons Expression numérique correspondant à la somme des valeurs spécifiant le nombre et le type de boutons à afficher, le style d'icône à utiliser, l'identité du bouton par défaut et la modalité du message. Pour les valeurs, reportez-vous à la section ci-après. Si elle est omise, la valeur par défaut de l'argument buttons est 0.
title Expression de chaîne affichée dans la barre de titre de la boîte de dialogue. Si vous omettez l'argument title, le nom de l'application s'affiche dans la barre de titre.
helpfile Expression de chaîne qui identifie le fichier d'aide à utiliser pour fournir l'aide contextuelle de la boîte de dialogue. Si l'argument helpfile est fourni, l'argument context doit aussi l'être. Non disponible aur les plates-formes 16 bits
context Expression numérique correspondant au numéro de contexte d'aide affecté par l'auteur de l'Aide à la rubrique d'aide appropriée. Si l'argument context est fourni, l'argument helpfile doit aussi l'être.

Valeurs
L'argument buttons peut prendre les valeurs suivantes:

Constante Valeur Description
vbOKOnly    0 Affiche uniquement le bouton OK.
vbOKCancel    1 Affiche les boutons OK et Annuler.
vbAbortRetryIgnore    2 Affiche les boutons Abandon, Réessayer et Ignorer.
vbYesNoCancel    3 Affiche les boutons Oui, Non et Annuler.
vbYesNo    4 Affiche les boutons Oui et Non.
vbRetryCancel    5 Affiche les boutons Réessayer et Annuler.
vbCritical   16 Affiche l'icône Message critique.
vbQuestion   32 Affiche l'icône Demande d'avertissement.
vbExclamation   48 Affiche l'icône Message d'avertissement.
vbInformation   64 Affiche l'icône Message d'information.
vbDefaultButton1    0 Le premier bouton est le bouton par défaut.
vbDefaultButton2  256 Le deuxième bouton est le bouton par défaut.
vbDefaultButton3  512 Le troisième bouton est le bouton par défaut.
vbDefaultButton4  768 Le quatrième bouton est le bouton par défaut.
vbApplicationModal    0 Application modale; l'utilisateur doit répondre au message avant de continuer à travailler dans l'application courante.
vbSystemModal 4096 Système modal; toutes les applications sont suspendues jusqu'à ce que l'utilisateur réponde au message.

Le premier groupe de valeurs (0 à 5) décrit le nombre et le type de boutons affichés dans la boîte de dialogue; le deuxième groupe (16, 32, 48, 64) décrit le style d'icône; le troisième groupe (0, 256, 512, 768) détermine le bouton par défaut; et le quatrième groupe (0, 4096) détermine la modalité du message. Au moment de l'ajout de nombres en vue de créer une valeur finale pour l'argument buttons, n'utilisez qu'un seul nombre de chaque groupe.

Valeurs renvoyées
La fonction MsgBox renvoie les valeurs suivantes:

Constante Valeur Bouton choisi
vbOK 1 OK
vbCancel 2 Annuler
vbAbort 3 Abandon
vbRetry 4 Réessayer
vbIgnore 5 Ignorer
vbYes 6 Oui
vbNo 7 Non

Notes
Quand les arguments helpfile et context sont tous deux fournis, l'utilisateur peut appuyer sur F1 pour afficher la rubrique d'aide correspondant au contexte.

Si la boîte de dialogue affiche un bouton Annuler, le fait d'appuyer sur la touche ÉCHAP a le même effet que de cliquer sur Annuler. Si la boîte de dialogue contient un bouton Aide, l'aide contextuelle est disponible pour la boîte de dialogue. Toutefois, aucune valeur n'est renvoyée avant qu'un des autres boutons ne soit sélectionné.

Lorsque la fonction MsgBox est utilisée avec Microsoft Internet Explorer, le titre de toute boîte de dialogue présentée contient toujours l'indication "VBScript:" pour la différencier des boîtes de dialogue système standard.

L'exemple ci-dessous utilise la fonction MsgBox pour afficher une boîte de message et renvoyer une valeur indiquant sur quel bouton l'utilisateur a cliqué :

Dim MyVar
MyVar = MsgBox ("Bonjour!", 65, 
"Exemple MsgBox") ' MyVar contient 1 ou 2,  
                                                  ' en fonction du bouton sur lequel 
                                                  ' l'utilisateur a cliqué.