WsCreateFaultFromError-Funktion (webservices.h)

Artikel
08/27/2023

Erstellt eine WS_FAULT aus einem angegebenen Fehlerobjekt.

Syntax

HRESULT WsCreateFaultFromError(
  [in]  WS_ERROR            *error,
  [in]  HRESULT             faultErrorCode,
  [in]  WS_FAULT_DISCLOSURE faultDisclosure,
  [in]  WS_HEAP             *heap,
  [out] WS_FAULT            *fault
);

Parameter

[in] error

Zeiger auf eine WS_ERROR Struktur, die das Fehlerobjekt darstellt, aus dem der Fehler erstellt werden soll.

[in] faultErrorCode

Der HRESULT-Fehlercode, der von der Funktion zurückgegeben wurde, bei der ein Fehler aufgetreten ist. Der HRESULT-Wert kann kein Erfolgscode sein.

Dieser Fehlercode ist nie direkt im Fehler enthalten, sondern wird als Fallbackmechanismus zum Erstellen einer Fehlerzeichenfolge verwendet, wenn das Fehlerobjekt keine Fehlerzeichenfolgen enthält.

[in] faultDisclosure

WS_FAULT_DISCLOSURE Enumeration, die steuert, welche Informationen aus dem Fehlerobjekt in das Fehlerobjekt kopiert werden.

[in] heap

Zeiger auf eine WS_HEAP Struktur, die den Heap darstellt, von dem Speicher für das zurückgegebene Fehlerobjekt zugewiesen werden soll.

[out] fault

Zeiger auf eine WS_FAULT Struktur, die das zurückgegebene Fehlerobjekt darstellt. Die Felder des Fehlerobjekts sind gut, bis WsFreeHeap oder WsResetHeap aufgerufen wird, um die angegebenen Heapressourcen freizugeben.

Rückgabewert

Wenn die Funktion erfolgreich ist, gibt sie NO_ERROR zurück. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Rückgabecode	Beschreibung
E_INVALIDARG	Mindestens ein Argument ist ungültig.
E_OUTOFMEMORY	Unzureichender Arbeitsspeicher, um den Vorgang abzuschließen.
Andere Fehler	Diese Funktion gibt möglicherweise andere Fehler zurück, die oben nicht aufgeführt sind.

Hinweise

Wenn das Fehlerobjekt einen Fehler enthält (d. h. der WS_FAULT_ERROR_PROPERTY_FAULT Wert von WS_FAULT_ERROR_PROPERTY_ID ist nicht NULL), wird dieser Fehler ausgewählt, um den zurückgegebenen Fehler zu erstellen.

Wenn das Fehlerobjekt keinen Fehler enthält (WS_FAULT_ERROR_PROPERTY_FAULT NULL ist), wird ein generischer Fehler mit einem generischen Fehlercode (und keinem Grundtext) ausgewählt, um den zurückgegebenen Fehler zu erstellen.

Wenn der ausgewählte Fehler keinen Grundtext enthält, wird der Fehlerursachentext gemäß dem Wert des Offenlegungsparameters erstellt:

WS_FULL_FAULT_DISCLOSURE Alle im Fehlerobjekt vorhandenen Fehlerzeichenfolgen werden zusammen angefügt, um den Grundtext zu bilden. Wenn keine Zeichenfolgen vorhanden sind, wird die dem parameter errorCode zugeordnete Zeichenfolge verwendet.
WS_MINIMAL_FAULT_DISCLOSURE Eine generische Fehlerzeichenfolge wird verwendet.

Standardmäßig ist die Sprache aller sprachabhängigen Informationen im Fehlerobjekt die aktuelle Benutzerstandardsprache der Benutzeroberflächen. Sie können die Sprache jedoch ändern, indem Sie die eigenschaft WS_ERROR_PROPERTY_LANGID festlegen. Weitere Informationen finden Sie in der WS_ERROR_PROPERTY_ID-Enumeration .

Anforderungen


Unterstützte Mindestversion (Client)	Windows 7 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 R2 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	webservices.h
Bibliothek	WebServices.lib
DLL	WebServices.dll

Freigeben über