IDebugErrorEvent2::GetErrorMessageIDebugErrorEvent2::GetErrorMessage

Retorna informações que permite 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
[out] Retorna um valor da MESSAGETYPE enumeração, que descreve o tipo de mensagem.[out] Returns a value from the MESSAGETYPE enumeration, describing the type of message.

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

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

pdwType
[out] Severidade do erro (usar constantes para MB_XXX MessageBox; por exemplo, 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] Caminho para um arquivo de Ajuda (definido como um valor nulo se não houver nenhum arquivo de Ajuda).[out] Path to a help file (set to a null value if there is no help file).

pdwHelpId
[out] ID do tópico da Ajuda para exibir (definido como 0 se não houver nenhum tópico da Ajuda).[out] ID of the help topic to display (set to 0 if there is no help topic).

Valor de retornoReturn Value

Se for bem-sucedido, retornará S_OK; 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 ser formatada ao longo das linhas de "What I was doing. %1".The error message should be formatted along the lines of "What I was doing. %1". O "%1" , em seguida, deve ser substituído pelo chamador com a mensagem de erro derivada do código de erro (que é retornado no 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 chamador como a mensagem de erro final deve ser exibida.The pMessageType parameter tells the caller how the final error message should be displayed.

Consulte tambémSee also