Fungsi WsAddCustomHeader (webservices.h)
Menambahkan header yang ditentukan aplikasi yang ditentukan ke pesan.
Sintaks
HRESULT WsAddCustomHeader(
[in] WS_MESSAGE *message,
[in] const WS_ELEMENT_DESCRIPTION *headerDescription,
[in] WS_WRITE_OPTION writeOption,
[in, ref] const void *value,
[in] ULONG valueSize,
[in] ULONG headerAttributes,
[in, optional] WS_ERROR *error
);
Parameter
[in] message
Pesan yang akan ditambahkan header.
Pesan dapat berada dalam status apa pun kecuali WS_MESSAGE_STATE_EMPTY (lihat enumerasi WS_MESSAGE_STATE ..
[in] headerDescription
Struktur WS_ELEMENT_DESCRIPTION yang menjelaskan header .
[in] writeOption
Apakah elemen header diperlukan, dan bagaimana nilai dialokasikan. Untuk informasi selengkapnya, lihat enumerasi WS_WRITE_OPTION .
[in, ref] value
Nilai header yang akan diserialisasikan. Untuk informasi selengkapnya, lihat enumerasi WS_WRITE_OPTION .
[in] valueSize
Ukuran nilai yang diserialisasikan, dalam byte.
[in] headerAttributes
Nilai atribut SOAP untuk header .
[in, optional] error
Penunjuk ke struktur WS_ERROR yang menerima informasi kesalahan tambahan jika fungsi gagal.
Mengembalikan nilai
Jika fungsi berhasil, fungsi akan mengembalikan NO_ERROR; jika tidak, kode kesalahan HRESULT akan dikembalikan.
Menampilkan kode | Deskripsi |
---|---|
|
Ada beberapa instans dari jenis header yang sama yang ada dalam pesan. |
|
Tidak cukup memori untuk menyelesaikan operasi. |
|
Satu atau beberapa parameter salah. |
|
Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas. |
Keterangan
Fungsi WsAddCustomHeader dirancang menangani jenis header yang ditargetkan pada penerima akhir. Header yang ditargetkan pada penerima lain diabaikan.
Jika Anda mengganti header, panggil fungsi WsRemoveCustomHeader untuk menghapus instans header yang ada sebelum memanggil WsAddCustomHeader.
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 |