Fungsi WsGetHeader (webservices.h)

Artikel
03/03/2024

Menemukan header standar tertentu dalam pesan dan mendeserialisasinya.

Sintaks

HRESULT WsGetHeader(
  [in]           WS_MESSAGE     *message,
  [in]           WS_HEADER_TYPE headerType,
  [in]           WS_TYPE        valueType,
  [in]           WS_READ_OPTION readOption,
  [in, optional] WS_HEAP        *heap,
                 void           *value,
  [in]           ULONG          valueSize,
  [in, optional] WS_ERROR       *error
);

Parameter

[in] message

Pesan yang berisi header .

Pesan dapat berada dalam status apa pun tetapi WS_MESSAGE_STATE_EMPTY.

[in] headerType

Jenis header yang akan dideserialisasi.

[in] valueType

Jenis nilai yang akan dideserialisasi. Lihat WS_HEADER_TYPE untuk kumpulan jenis yang sesuai dengan setiap jenis header.

[in] readOption

Apakah nilai diperlukan, dan cara mengalokasikan nilai. opsi baca WS_READ_NILLABLE_VALUE dan WS_READ_NILLABLE_POINTER tidak dapat ditentukan karena jenis header di WS_HEADER_TYPE tidak diizinkan untuk nillable dalam spesifikasi standar masing-masing. Lihat WS_READ_OPTION untuk informasi selengkapnya.

[in, optional] heap

Timbunan untuk menyimpan data header yang dideserialisasi. Jika ini NULL, maka timbunan pesan akan digunakan.

value

Interpretasi parameter ini tergantung pada WS_READ_OPTION.

[in] valueSize

Interpretasi parameter ini tergantung pada WS_READ_OPTION.

[in, optional] error

Menentukan di mana informasi kesalahan tambahan harus disimpan jika fungsi gagal.

Mengembalikan nilai

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
WS_E_INVALID_FORMAT	Header tidak ada, dan diperlukan. Ada beberapa contoh jenis header yang ada dalam pesan. Data input tidak dalam format yang diharapkan.
WS_E_QUOTA_EXCEEDED	Kuota ukuran timbunan terlampaui.
E_OUTOFMEMORY	Tidak tersedia cukup memori untuk mendeserialisasi header.
E_INVALIDARG	Satu atau beberapa parameter salah.
Kesalahan Lainnya	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Keterangan

API ini menyediakan akses ke sekumpulan jenis header standar (lihat WS_HEADER_TYPE). Untuk jenis header yang ditentukan aplikasi, gunakan WsGetCustomHeader.

API ini dirancang menangani jenis header yang muncul sekali dalam pesan dan ditargetkan pada penerima utama. Header yang ditargetkan dengan peran/aktor selain penerima utama diabaikan oleh API ini.

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