WPRCFormatError

WPRCFormatError 是一个用于根据 HRESULT 错误代码设置错误消息的格式的函数。 它提供了一种检索错误消息的方法。

语法

HRESULT WPRCFormatError(  
    _In_ HRESULT Hresult,   
    _In_opt_ LPUNKNOWN pUnknown,   
    _Out_ BSTR* pbstrMessage,   
    _Out_opt_ BSTR* pbstrDescription,   
    _Out_opt_ BSTR* pbstrDetailedDescription  
); 

parameters

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 代码指示，表示在执行函数期间发生了错误。

注解

相关主题

函数