IDebugErrorEvent2::GetErrorMessage
Возвращает сведения, позволяющие создать сообщение об ошибке, доступное для чтения человеком.
Синтаксис
int GetErrorMessage(
out enum_MESSAGETYPE pMessageType,
out string pbstrErrorFormat,
out int phrErrorReason,
out uint pdwType,
out string pbstrHelpFileName,
out uint pdwHelpId
);
Параметры
pMessageType
[out] Возвращает значение из перечисления MESSAGETYPE , описывающее тип сообщения.
pbstrErrorFormat
[out] Формат окончательного сообщения пользователю (дополнительные сведения см. в разделе "Примечания").
hrErrorReason
[out] Код ошибки, о чем идет сообщение.
pdwType
[out] Серьезность ошибки (используйте константы МБ_XXX для MessageBox
; например, MB_EXCLAMATION
или MB_WARNING
).
pbstrHelpFileName
[out] Путь к файлу справки (задайте значение NULL, если файл справки отсутствует).
pdwHelpId
[out] Идентификатор отображаемого раздела справки (задайте значение 0, если нет раздела справки).
Возвращаемое значение
В случае успешного выполнения возвращается S_OK
; в противном случае возвращается код ошибки.
Замечания
Сообщение об ошибке должно быть отформатировано по строкам "What I was doing. %1"
. Затем "%1"
вызывающий объект заменится сообщением об ошибке, производным от кода ошибки (который возвращается в hrErrorReason
). Параметр pMessageType
сообщает вызывающему объекту, как должно отображаться окончательное сообщение об ошибке.