IDebugErrorEvent2::GetErrorMessageIDebugErrorEvent2::GetErrorMessage

Retorna informações que permitem a construção de uma mensagem de erro legível por humanos.Returns information that allows construction of a human-readable error message.

SintaxeSyntax

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
);

parâmetrosParameters

pMessageType
[fora] Retorna um valor da enumeração MESSAGETYPE, descrevendo o tipo de mensagem.[out] Returns a value from the MESSAGETYPE enumeration, describing the type of message.

pbstrErrorFormat
[fora] O formato da mensagem final para o usuário (consulte "Observações" para obter detalhes).[out] The format of the final message to the user (see "Remarks" for details).

hrErrorReason
[fora] O código de erro da mensagem é sobre.[out] The error code the message is about.

pdwType
[fora] Gravidade do erro (use as para MessageBoxMB_XXX; por MB_EXCLAMATION MB_WARNINGexemplo, ou ).[out] Severity of the error (use the MB_XXX constants for MessageBox; for example, MB_EXCLAMATION or MB_WARNING).

pbstrHelpFileName
[fora] Caminho para um arquivo de ajuda (definido como um valor nulo se não houver arquivo de ajuda).[out] Path to a help file (set to a null value if there is no help file).

pdwHelpId
[fora] ID do tópico de ajuda a ser exibido (definido como 0 se não houver tópico de ajuda).[out] ID of the help topic to display (set to 0 if there is no help topic).

Valor retornadoReturn Value

Se for S_OKbem sucedido, retorna; caso contrário, retorna um código de erro.If successful, returns S_OK; otherwise, returns an error code.

ComentáriosRemarks

A mensagem de erro deve "What I was doing. %1"ser formatada ao longo das linhas de .The error message should be formatted along the lines of "What I was doing. %1". O "%1" seria então substituído pelo chamador com a mensagem de erro derivada do código de erro (que é devolvido em hrErrorReason).The "%1" would then be replaced by the caller with the error message derived from the error code (which is returned in hrErrorReason). O pMessageType parâmetro informa ao interlocutor como a mensagem de erro final deve ser exibida.The pMessageType parameter tells the caller how the final error message should be displayed.

Confira tambémSee also