IDebugErrorEvent2::GetErrorMessage
Retourne des informations qui permettent la construction d’un message d’erreur lisible par l’homme.
Syntaxe
int GetErrorMessage(
out enum_MESSAGETYPE pMessageType,
out string pbstrErrorFormat,
out int phrErrorReason,
out uint pdwType,
out string pbstrHelpFileName,
out uint pdwHelpId
);
Paramètres
pMessageType
[out] Retourne une valeur de l’énumération MESSAGETYPE , décrivant le type de message.
pbstrErrorFormat
[out] Format du message final à l’utilisateur (voir « Remarques » pour plus d’informations).
hrErrorReason
[out] Code d’erreur à propos du message.
pdwType
[out] Gravité de l’erreur (utilisez les constantes Mo_XXX pour MessageBox
; par exemple, MB_EXCLAMATION
ou MB_WARNING
).
pbstrHelpFileName
[out] Chemin d’accès à un fichier d’aide (défini sur une valeur Null s’il n’existe aucun fichier d’aide).
pdwHelpId
[out] ID de la rubrique d’aide à afficher (défini sur 0 s’il n’existe aucune rubrique d’aide).
Valeur de retour
En cas de réussite, retourne S_OK
, sinon, retourne un code d'erreur.
Notes
Le message d’erreur doit être mis en forme le long des lignes de "What I was doing. %1"
. L’appelant "%1"
est ensuite remplacé par le message d’erreur dérivé du code d’erreur (qui est retourné dans hrErrorReason
). Le pMessageType
paramètre indique à l’appelant comment le message d’erreur final doit être affiché.