Fungsi WsGetFaultErrorDetail (webservices.h)

Artikel
03/03/2024

Baca detail kesalahan yang disimpan dalam objek WS_ERROR .

Sintaks

HRESULT WsGetFaultErrorDetail(
  [in]           WS_ERROR                          *error,
  [in]           const WS_FAULT_DETAIL_DESCRIPTION *faultDetailDescription,
  [in]           WS_READ_OPTION                    readOption,
  [in, optional] WS_HEAP                           *heap,
                 void                              *value,
  [in]           ULONG                             valueSize
);

Parameter

[in] error

Objek kesalahan yang berisi informasi kesalahan.

[in] faultDetailDescription

Penunjuk ke deskripsi elemen detail kesalahan.

Nilai tindakan deskripsi detail kesalahan digunakan sebagai nilai filter untuk mencocokkan dengan tindakan kesalahan. Jika kedua string tindakan ditentukan (nilai tindakan deskripsi detail kesalahan bukan NULL dan nilai tindakan WS_FAULT_ERROR_PROPERTY_ACTION dalam WS_ERROR memiliki panjang lebih besar dari nol), maka string tindakan dibandingkan untuk menentukan kecocokan. Jika ada kecocokan, maka fungsi kemudian akan mencoba mendeserialisasi elemen detail.

Deskripsi elemen dari deskripsi detail kesalahan digunakan untuk menjelaskan format elemen dalam detail kesalahan.

[in] readOption

Apakah elemen diperlukan, dan cara mengalokasikan nilai. Lihat WS_READ_OPTION untuk informasi selengkapnya.

[in, optional] heap

Timbunan untuk menyimpan nilai yang dideserialisasi.

value

Interpretasi parameter ini tergantung pada WS_READ_OPTION.

[in] valueSize

Interpretasi parameter ini tergantung pada WS_READ_OPTION.

Mengembalikan nilai

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
WS_E_INVALID_FORMAT	Data input tidak dalam format yang diharapkan atau tidak memiliki nilai yang diharapkan.
E_OUTOFMEMORY	Kehabisan memori.
WS_E_QUOTA_EXCEEDED	Kuota ukuran tumpukan terlampaui.
E_INVALIDARG	Satu atau beberapa argumen tidak valid.

Keterangan

API ini mendeserialisasi nilai dari bidang detail WS_FAULT yang disimpan di objek WS_ERROR .

Fungsi ini mendukung skenario berikut, berdasarkan konten WS_ELEMENT_DESCRIPTION dalam WS_FAULT_DETAIL_DESCRIPTION yang disediakan:

Membaca satu elemen. Dalam hal ini, bidang elementLocalName dan elementNs dari WS_ELEMENT_DESCRIPTION harus diatur ke nama lokal dan namespace elemen untuk dibaca, dan deskripsi jenis dan jenis mewakili jenis nilai yang sedang dideserialisasi.
Karena kesalahan yang berbeda dengan format detail yang berbeda mungkin diharapkan dari layanan, fungsi ini dapat dipanggil secara berturut-turut untuk mencoba membaca setiap jenis detail. Dalam hal ini, nilai WS_READ_OPTIONAL_POINTER dapat ditentukan, yang akan mengembalikan penunjuk NULL jika nama elemen dalam detail kesalahan tidak cocok dengan nilai yang diharapkan.
Membaca beberapa elemen sebagai nilai tunggal. Dalam hal ini, bidang elementLocalName dan elementNs dari WS_ELEMENT_DESCRIPTION harus diatur ke NULL, dan WS_STRUCT_TYPE dan WS_STRUCT_DESCRIPTION harus ditentukan. Setiap bidang nilai struktur yang dideserialisasi harus sesuai dengan elemen yang akan dibaca dalam isi. Parameter readOption harus WS_READ_REQUIRED_VALUE atau WS_READ_REQUIRED_POINTER.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 7 [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 R2 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	webservices.h
Pustaka	WebServices.lib
DLL	WebServices.dll

Bagikan melalui