WsSetFaultErrorDetail-Funktion (webservices.h)

Artikel
03/09/2024

Schreiben Sie die in einem WS_ERROR-Objekt gespeicherten Fehlerdetails.

Syntax

HRESULT WsSetFaultErrorDetail(
  [in] WS_ERROR                          *error,
  [in] const WS_FAULT_DETAIL_DESCRIPTION *faultDetailDescription,
  [in] WS_WRITE_OPTION                   writeOption,
       const void                        *value,
  [in] ULONG                             valueSize
);

Parameter

[in] error

Das Fehlerobjekt, das die Fehlerinformationen enthält.

[in] faultDetailDescription

Ein Zeiger auf eine Beschreibung des Fehlerdetails.

Wenn das Aktionsfeld der Fehlerdetailbeschreibung ungleich NULL ist, wird es als WS_FAULT_ERROR_PROPERTY_ACTION des WS_ERROR festgelegt.

Die Elementbeschreibung der Fehlerdetails beschreibt das Format des Elements im Fehlerdetails.

[in] writeOption

Informationen darüber, wie der Wert zugeordnet wird. Weitere Informationen finden Sie unter WS_WRITE_OPTION .

value

Ein Zeiger auf den zu serialisierenden Wert.

[in] valueSize

Die Größe des zu serialisierenden Werts in Bytes.

Wenn der Wert NULL ist, sollte die Größe 0 sein.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	Beschreibung
WS_E_INVALID_FORMAT	Die Eingabedaten hatten nicht das erwartete Format oder hatten nicht den erwarteten Wert.
E_INVALIDARG	Mindestens ein Argument ist ungültig.
E_OUTOFMEMORY	Der Arbeitsspeicher ist nicht mehr vorhanden.

Hinweise

Diese API serialisiert den Wert des Detailfelds der im WS_ERROR-Objekt gespeicherten WS_FAULT.

Diese Funktionen unterstützen die folgenden Szenarien basierend auf dem Inhalt der WS_ELEMENT_DESCRIPTION in den bereitgestellten WS_FAULT_DETAIL_DESCRIPTION :

Schreiben eines einzelnen Elements. In diesem Fall sollten die Felder elementLocalName und elementNs des WS_ELEMENT_DESCRIPTION auf den lokalen Namen und Namespace des zu schreibenden Elements festgelegt werden, und die Typ- und Typbeschreibung stellt den Typ des Werts dar, der serialisiert wird.
Schreiben mehrerer Elemente als einzelner Wert. In diesem Fall sollten die Felder elementLocalName und elementNs des WS_ELEMENT_DESCRIPTION auf NULL festgelegt werden, und es sollten ein WS_STRUCT_TYPE und WS_STRUCT_DESCRIPTION angegeben werden. Jedes Feld des Strukturwerts, der serialisiert wird, sollte den Elementen entsprechen, die innerhalb des Fehlerdetails geschrieben werden sollen. Der parameter writeOption muss entweder WS_WRITE_REQUIRED_VALUE oder WS_WRITE_REQUIRED_POINTER sein.

Anforderungen

Anforderung	Wert
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