WPRCFormatError
WPRCFormatError
ist eine Funktion zum Formatieren von Fehlermeldungen basierend auf HRESULT-Fehlercodes. Sie bietet eine Möglichkeit zum Abrufen von Fehlermeldungen.
Syntax
HRESULT WPRCFormatError(
_In_ HRESULT Hresult,
_In_opt_ LPUNKNOWN pUnknown,
_Out_ BSTR* pbstrMessage,
_Out_opt_ BSTR* pbstrDescription,
_Out_opt_ BSTR* pbstrDetailedDescription
);
Parameter
Hresult
(_In_ HRESULT)
: Der HRESULT-Fehlercode, der formatiert werden muss. Dieser Parameter ist erforderlich.
pUnknown
(_In_opt_ LPUNKNOWN)
: Ein optionaler Schnittstellenzeiger, der möglicherweise zusätzlichen Kontext zum Formatieren des Fehlers bereitstellt. Dies kann NULL
sein, falls nicht verwendet.
pbstrMessage
(_Out_ BSTR*)
: Ein Zeiger auf eine BSTR
-Zeichenfolge, die die primäre Fehlermeldung empfängt. Es handelt sich hierbei um einen obligatorischen Ausgabeparameter.
pbstrDescription
(_Out_opt_ BSTR*)
: Ein optionaler Zeiger auf eine BSTR
-Zeichenfolge, die eine detailliertere Beschreibung des Fehlers erhält. Dies kann NULL
sein, falls nicht erforderlich.
pbstrDetailedDescription
(_Out_opt_ BSTR*)
: Ein optionaler Zeiger auf eine BSTR
-Zeichenfolge, die eine noch detailliertere Beschreibung des Fehlers erhält. Dies kann auch NULL
sein, falls nicht erforderlich.
Rückgabewert
Die Funktion gibt einen HRESULT-Code zurück. Eine erfolgreiche Ausführung wird in der Regel durch S_OK angegeben. Fehler werden durch einen anderen HRESULT-Code angegeben, der einen Fehler während der Ausführung der Funktion angibt.