WPRCFormatError
WPRCFormatError
é uma função criada para formatar mensagens de erro com base em códigos de erro HRESULT. Ela permite recuperar mensagens de erro.
Sintaxe
HRESULT WPRCFormatError(
_In_ HRESULT Hresult,
_In_opt_ LPUNKNOWN pUnknown,
_Out_ BSTR* pbstrMessage,
_Out_opt_ BSTR* pbstrDescription,
_Out_opt_ BSTR* pbstrDetailedDescription
);
Parâmetros
Hresult
(_In_ HRESULT)
: o código de erro HRESULT que precisa ser formatado. Esse parâmetro é obrigatório.
pUnknown
(_In_opt_ LPUNKNOWN)
: um ponteiro de interface opcional que pode fornecer contexto adicional para formatar o erro. Ele poderá ser NULL
se não for usado.
pbstrMessage
(_Out_ BSTR*)
: um ponteiro para uma cadeia de caracteres BSTR
que receberá a mensagem de erro principal. Esse parâmetro de saída é obrigatório.
pbstrDescription
(_Out_opt_ BSTR*)
: um ponteiro opcional para uma cadeia de caracteres BSTR
que receberá uma descrição mais detalhada do erro. Ele poderá ser NULL
se não for obrigatório.
pbstrDetailedDescription
(_Out_opt_ BSTR*)
: um ponteiro opcional para uma cadeia de caracteres BSTR
que receberá uma descrição ainda mais detalhada do erro. Ele também poderá ser NULL
se não for obrigatório.
Valor de retorno
A função retorna um código HRESULT. Uma execução bem-sucedida é normalmente indicada por S_OK. Uma falha é indicada por qualquer outro código HRESULT, o que significa que ocorreu um erro durante a execução da função.