IDebugErrorEvent2::GetErrorMessageIDebugErrorEvent2::GetErrorMessage
- 2 minutes de lecture
-
Contributeurs
Retourne des informations qui permet la construction d’un message d’erreur explicite.Returns information that allows construction of a human-readable error message.
SyntaxeSyntax
HRESULT GetErrorMessage(
MESSAGETYPE* pMessageType,
BSTR* pbstrErrorFormat,
HRESULT* hrErrorReason,
DWORD* pdwType,
BSTR* pbstrHelpFileName,
DWORD* pdwHelpId
);
int GetErrorMessage(
out enum_MESSAGETYPE pMessageType,
out string pbstrErrorFormat,
out int phrErrorReason,
out uint pdwType,
out string pbstrHelpFileName,
out uint pdwHelpId
);
ParamètresParameters
pMessageType
[out] Retourne une valeur de la MESSAGETYPE énumération décrivant le type de message.[out] Returns a value from the MESSAGETYPE enumeration, describing the type of message.
pbstrErrorFormat
[out] Le format du message à l’utilisateur final (voir la section « Notes »).[out] The format of the final message to the user (see "Remarks" for details).
hrErrorReason
[out] Le code d’erreur le message concerne.[out] The error code the message is about.
pdwType
[out] Gravité de l’erreur (utiliser l’une des constantes pour MB_XXX MessageBox; par exemple, MB_EXCLAMATION ou MB_WARNING).[out] Severity of the error (use the MB_XXX constants for MessageBox; for example, MB_EXCLAMATION or MB_WARNING).
pbstrHelpFileName
[out] Chemin d’accès à un fichier d’aide (défini à une valeur null s’il n’existe aucun fichier d’aide).[out] Path to a help file (set to a null value if there is no help file).
pdwHelpId
[out] ID de la rubrique d’aide à afficher (défini à 0 s’il n’existe aucune rubrique d’aide).[out] ID of the help topic to display (set to 0 if there is no help topic).
Valeur de retourReturn Value
En cas de réussite, retourne S_OK; sinon, retourne un code d’erreur.If successful, returns S_OK; otherwise, returns an error code.
NotesRemarks
Le message d’erreur doit être mis en forme le long des lignes de "What I was doing. %1".The error message should be formatted along the lines of "What I was doing. %1". Le "%1" aurait ensuite été remplacé par l’appelant par le message d’erreur dérivé le code d’erreur (laquelle est retournée dans hrErrorReason).The "%1" would then be replaced by the caller with the error message derived from the error code (which is returned in hrErrorReason). Le pMessageType paramètre indique comment le dernier message d’erreur doit être affiché à l’appelant.The pMessageType parameter tells the caller how the final error message should be displayed.