Fungsi WsSetHeader (webservices.h)
Menambahkan atau mengganti header standar yang ditentukan dalam pesan.
Sintaks
HRESULT WsSetHeader(
[in] WS_MESSAGE *message,
[in] WS_HEADER_TYPE headerType,
[in] WS_TYPE valueType,
[in] WS_WRITE_OPTION writeOption,
const void *value,
[in] ULONG valueSize,
[in, optional] WS_ERROR *error
);
Parameter
[in] message
Pesan untuk mengatur header.
Pesan dapat berada dalam status apa pun tetapi WS_MESSAGE_STATE_EMPTY.
[in] headerType
Jenis header yang akan diserialisasikan.
[in] valueType
Jenis nilai yang akan diserialisasikan. Lihat WS_HEADER_TYPE untuk kumpulan jenis yang didukung untuk setiap jenis header.
[in] writeOption
Apakah elemen header diperlukan, dan bagaimana nilai dialokasikan. opsi penulisan WS_WRITE_NILLABLE_VALUE dan WS_WRITE_NILLABLE_POINTER tidak dapat ditentukan karena jenis header di WS_HEADER_TYPE tidak diizinkan untuk menjadi nillable dalam spesifikasi standar masing-masing. Lihat WS_WRITE_OPTION untuk informasi selengkapnya.
value
Nilai header yang akan diserialisasikan. Lihat WS_WRITE_OPTION untuk informasi selengkapnya.
[in] valueSize
Ukuran nilai yang diserialisasikan, dalam byte.
[in, optional] error
Menentukan tempat informasi kesalahan tambahan harus disimpan jika fungsi gagal.
Nilai kembali
Fungsi ini dapat mengembalikan salah satu nilai ini.
Menampilkan kode | Deskripsi |
---|---|
|
Ada beberapa contoh jenis header yang ada dalam pesan. |
|
Tidak tersedia cukup memori untuk membuat serial header. |
|
Satu atau beberapa parameter salah. |
|
Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas. |
Keterangan
API ini memungkinkan pengaturan jenis header standar (lihat WS_HEADER_TYPE). Untuk jenis header yang ditentukan aplikasi, gunakan WsAddCustomHeader.
API ini dirancang untuk 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.
Jika header dari jenis yang diberikan (ditargetkan pada penerima akhir) sudah ada dalam pesan, itu diganti.
Persyaratan
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 |