Session. message, méthode

La méthode message de l’objet session effectue toutes les opérations de journalisation activées et diffère l’exécution à l’objet gestionnaire d’interface utilisateur associé au moteur. La journalisation peut être activée de manière sélective pour les différents types de messages. Consultez la méthode EnableLog .

Si le champ d’enregistrement 0 contient une chaîne de mise en forme, il est utilisé pour mettre en forme les données dans les autres champs. Sinon, si le message est une erreur, un avertissement ou un message utilisateur, une tentative est faite pour trouver un modèle de message dans la table d’erreurs pour la base de données actuelle à l’aide du numéro d’erreur trouvé dans le champ 1 de l’enregistrement pour les types de messages et les valeurs de retour.

Syntaxe

Session.Message(
  kind,
  record
)

Paramètres

kind

Le paramètre Kind doit avoir l’une des valeurs suivantes. Pour afficher une boîte de message avec des boutons et des icônes de type push, calculez la valeur de genre en ajoutant les styles de zone de message standard utilisés par MessageBox et MessageBoxEx à msiMessageTypeError, msiMessageTypeWarning ou msiMessageTypeUser. Pour plus d’informations, consultez la section Notes ci-dessous.

Constante Signification
msiMessageTypeFatalExit
&H00000000
Arrêt prématuré, risque de manquer de mémoire.
msiMessageTypeError
&H01000000
Message d’erreur mis en forme, [ 1 ] est le numéro de message dans la table d’erreurs.
msiMessageTypeWarning
&H02000000
Message d’avertissement mis en forme, [ 1 ] est le numéro de message dans la table d’erreurs.
msiMessageTypeUser
&H03000000
Message de demande utilisateur, [ 1 ] est le numéro de message dans la table d’erreurs.
msiMessageTypeInfo
&H04000000
Message d’information pour le journal, à ne pas afficher.
msiMessageTypeFilesInUse
&H05000000
Liste des fichiers en cours d’utilisation qui doivent être remplacés.
msiMessageTypeResolveSource
&H06000000
Demandez à déterminer un emplacement source valide.
msiMessageTypeOutOfDiskSpace
&H07000000
Message d’espace disque insuffisant.
msiMessageTypeActionStart
&H08000000
Début de l’action, [ 1 ] nom d’action, [ 2 ] Description, [ 3 ] modèle pour les messages ACTIONDATA.
msiMessageTypeActionData
&H09000000
Données d’action. Les champs d’enregistrement correspondent au modèle de message ACTIONSTART.
msiMessageTypeProgress
&H0A000000
Informations sur la barre de progression. Consultez la description des champs d’enregistrement ci-dessous.
msiMessageTypeCommonData
&H0B000000
Pour activer le bouton Annuler défini [ ] entre 1 et 2 [ ] à 1.
Pour désactiver le bouton Annuler défini [ ] entre 1 et 2 et [ 2 ] à 0

enregistrement

Objet Record requis contenant un champ spécifique au message.

Valeur de retour

Constante Valeur
msiMessageStatusError
-1
msiMessageStatusNone
0
msiMessageStatusOk
1
msiMessageStatusCancel
2
msiMessageStatusAbort
3
msiMessageStatusRetry
4
msiMessageStatusIgnore
5
msiMessageStatusYes
6
msiMessageStatusNo
7

Notes

Champs d’enregistrement de message

La rubrique suivante décrit les définitions de champs d’enregistrement lorsque msiMessageTypeProgress est transmis comme type de message.

Le champ 1 spécifie le type de message de progression. La signification des autres champs dépend de la valeur de ce champ. Les valeurs possibles qui peuvent être définies dans le champ 1 sont les suivantes.

Nom du message Valeur Description du champ 1
MasterReset 0 Réinitialise la barre de progression et définit le nombre total de graduations attendu dans la barre.
ActionInfo 1 Fournit des informations relatives aux messages de progression qui doivent être envoyés par l’action en cours.
ProgressReport 2 Incrémente la barre de progression.
ProgressAddition 3 Permet à une action (telle que CustomAction) d’ajouter des graduations au nombre total attendu de la progression de la barre de progression.

La signification du champ 2 dépend de la valeur du champ 1 comme suit.

Valeur champ 1 Description du champ 2
0 Nombre total de graduations attendu dans la barre de progression.
1 Nombre de graduations que la barre de progression déplace pour chaque message ActionData. Ce champ est ignoré si le champ 3 est égal à 0.
2 Nombre de graduations de la barre de progression.
3 Nombre de graduations à ajouter à la progression attendue totale.

La signification du champ 3 dépend de la valeur du champ 1 comme suit.

Valeur champ 1 Valeur champ 3 Description du champ 3
0 0 Barre de progression vers l’avant (de gauche à droite)
1 Barre de progression vers l’arrière (de droite à gauche)
1 0 L’action en cours enverra des messages ProgressReport explicites.
1 Incrémente la barre de progression du nombre de graduations spécifié dans le champ 2 chaque fois qu’un message ActionData est envoyé.
2 Inutilisé
3 Inutilisé

La signification du champ 4 dépend de la valeur du champ 1 comme suit.

Valeur champ 1 Valeur champ 4 Description du champ 4
0 0 L’exécution est en cours. Dans ce cas, l’interface utilisateur peut calculer et afficher le temps restant.
1 Création du script d’exécution. Dans ce cas, l’interface utilisateur peut afficher un message pour patienter pendant que le programme d’installation a terminé la préparation de l’installation.
1 Inutilisé
2 Inutilisé
3 Inutilisé

Affichage des boîtes de message

Pour afficher une boîte de message avec des boutons et des icônes de type push, calculez la valeur de genre en ajoutant les styles de zone de message standard utilisés par MessageBox et MessageBoxEx à msiMessageTypeError, msiMessageTypeWarning ou msiTypeUser. Les options de bouton de commande disponibles pour VBScript sont vbOKOnly (Mo _ OK), vbOKCancel (MB _ OKCANCEL), VBABORTRETRYIGNORE (Mo _ ABORTRETRYIGNORE), vbYesNoCancel (Mo _ YESNOCANCEL), vbYesNo (Mo _ YesNo) et vbRetryCancel (Mo _ RETRYCANCEL). Les options d’icône disponibles pour VBScript sont vbCritical (Mo _ ICONERROR), vbQuestion (MB _ ICONQUESTION), VBEXCLAMATION (Mo _ ICONWARNING) et vbInformation (Mo _ ICONINFORMATION).

Par exemple, l’appel suivant envoie un message msiMessageTypeError avec l’icône vbExclamation et les boutons vbYesNo.

Session.Message &H01000034, record

Si une action personnalisée appelle la méthode de message , l’action personnalisée doit être en mesure de gérer une annulation par l’utilisateur et de retourner msiDoActionStatusUserExit.

Spécifications

Condition requise Valeur
Version
Windows Installer 5,0 sur Windows Server 2012, Windows 8, Windows Server 2008 R2 ou Windows 7. Windows Installer 4,0 ou Windows Installer 4,5 sur Windows Server 2008 ou Windows Vista. Windows Installer sur Windows Server 2003 ou Windows XP
DLL
Msi.dll
IID
IID _ ISession est défini en tant que 000C109E-0000-0000-C000-000000000046