WPRCFormatError
WPRCFormatError
es una función diseñada para formatear los mensajes de error basados en los códigos de error HRESULT. Proporciona una forma de recuperar los mensajes de error.
Sintaxis
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)
: El código de error HRESULT que se tiene que formatearse. Este parámetro es obligatorio.
pUnknown
(_In_opt_ LPUNKNOWN)
: Un puntero de interfaz opcional que podría proporcionar un contexto adicional para formatear el error. Esto puede ser NULL
si no se usa.
pbstrMessage
(_Out_ BSTR*)
: Un puntero hacia una BSTR
cadena que recibirá el mensaje de error principal. Este es un parámetro de salida obligatorio.
pbstrDescription
(_Out_opt_ BSTR*)
: Un puntero opcional hacia una BSTR
cadena que recibirá una descripción más detallada del error. Esto puede ser NULL
si no es necesario.
pbstrDetailedDescription
(_Out_opt_ BSTR*)
: Un puntero opcional hacia una BSTR
cadena que recibirá una descripción aún más detallada del error. Esto también puede ser NULL
si no es necesario.
Valor devuelto
La función devuelve un código HRESULT. Una ejecución exitosa generalmente se indica con S_OK. El fallo se indica mediante cualquier otro código HRESULT, lo cual significa que se produjo un error durante la ejecución de la función.