IDebugErrorEvent2::GetErrorMessage
Retorna informações que permitem a construção de uma mensagem de erro legível por humanos.
Sintaxe
int GetErrorMessage(
out enum_MESSAGETYPE pMessageType,
out string pbstrErrorFormat,
out int phrErrorReason,
out uint pdwType,
out string pbstrHelpFileName,
out uint pdwHelpId
);
Parâmetros
pMessageType
[saiu] Retorna um valor da enumeração MESSAGETYPE , descrevendo o tipo de mensagem.
pbstrErrorFormat
[saiu] O formato da mensagem final para o usuário (consulte "Observações" para obter detalhes).
hrErrorReason
[saiu] O código de erro sobre o qual a mensagem se refere.
pdwType
[saiu] Gravidade do erro (use as constantes MB_XXX para MessageBox
; por exemplo, MB_EXCLAMATION
ou MB_WARNING
).
pbstrHelpFileName
[saiu] Caminho para um arquivo de ajuda (definido como um valor nulo se não houver nenhum arquivo de ajuda).
pdwHelpId
[saiu] ID do tópico de ajuda a ser exibido (definido como 0 se não houver nenhum tópico de ajuda).
Valor de retorno
Se tiver êxito, retornará S_OK
. Caso contrário, retornará um código de erro.
Comentários
A mensagem de erro deve ser formatada ao longo das linhas de "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 é retornado em hrErrorReason
). O pMessageType
parâmetro informa ao chamador como a mensagem de erro final deve ser exibida.