WPRCFormatError
WPRCFormatError
— это функция, предназначенная для форматирования сообщений об ошибках на основе кодов ошибок HRESULT. Он предоставляет способ получения сообщений об ошибках.
Синтаксис
HRESULT WPRCFormatError(
_In_ HRESULT Hresult,
_In_opt_ LPUNKNOWN pUnknown,
_Out_ BSTR* pbstrMessage,
_Out_opt_ BSTR* pbstrDescription,
_Out_opt_ BSTR* pbstrDetailedDescription
);
Параметры
Hresult
(_In_ HRESULT)
: код ошибки HRESULT, который необходимо отформатировать. Это обязательный параметр.
pUnknown
(_In_opt_ LPUNKNOWN)
: необязательный указатель интерфейса, который может предоставить дополнительный контекст для форматирования ошибки. Это может быть, если оно не используется NULL
.
pbstrMessage
(_Out_ BSTR*)
: указатель на BSTR
строку, которая получит основное сообщение об ошибке. Это обязательный выходной параметр.
pbstrDescription
(_Out_opt_ BSTR*)
: необязательный указатель на BSTR
строку, которая получит более подробное описание ошибки. Это может быть, если это не требуется NULL
.
pbstrDetailedDescription
(_Out_opt_ BSTR*)
: необязательный указатель на BSTR
строку, которая получит еще более подробное описание ошибки. Это также может быть, если это не требуется NULL
.
Возвращаемое значение
Функция возвращает код HRESULT. Успешное выполнение обычно указывается S_OK. Сбой обозначается любым другим кодом HRESULT, который означает ошибку во время выполнения функции.