Fungsi WsAddMappedHeader (webservices.h)

Artikel
01/27/2024

Menambahkan header yang dipetakan tertentu ke pesan.

Sintaks

HRESULT WsAddMappedHeader(
  [in]           WS_MESSAGE          *message,
  [in]           const WS_XML_STRING *headerName,
  [in]           WS_TYPE             valueType,
  [in]           WS_WRITE_OPTION     writeOption,
  [in]           const void          *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Parameter

[in] message

Penunjuk ke struktur WS_MESSAGE yang mewakili pesan untuk menambahkan header yang dipetakan.

Pesan dapat berada dalam status apa pun kecuali WS_MESSAGE_STATE_EMPTY (lihat enumerasi WS_MESSAGE_STATE .

[in] headerName

Penunjuk ke WS_XML_STRING yang berisi nama header.

[in] valueType

Jenis nilai header yang akan dideserialisasi. Untuk jenis yang mungkin dan header yang sesuai, lihat WS_HEADER_TYPE

[in] writeOption

Apakah header diperlukan, dan bagaimana nilai dialokasikan. Untuk informasi selengkapnya, lihat enumerasi WS_WRITE_OPTION .

[in] value

Nilai header yang akan diserialisasikan. Untuk informasi selengkapnya, lihat enumerasi WS_WRITE_OPTION .

[in] valueSize

Ukuran nilai yang diserialisasikan, dalam byte.

[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
E_OUTOFMEMORY	Tidak cukup memori untuk menyelesaikan operasi.
E_INVALIDARG	Satu atau beberapa parameter salah.
Kesalahan Lainnya	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Keterangan

Pesan mungkin berisi informasi khusus transportasi tambahan yang bukan bagian dari amplop pesan. Informasi khusus transportasi ini dapat diekspos secara terprogram sebagai header pesan. Fungsi WsAddMappedHeader digunakan untuk menambahkan header seperti itu yang akan dipetakan ke beberapa lokasi khusus transportasi.

Ketika Anda menggunakan saluran HTTP, Anda harus menentukan pemetaan yang diperlukan sebelum Anda memanggil fungsi ini untuk menambahkan header. Untuk informasi selengkapnya, lihat WS_HTTP_MESSAGE_MAPPING.

Jika Anda mengganti header, panggil fungsi WsRemoveMappedHeader untuk menghapus instans header yang ada sebelum Anda memanggil WsAddMappedHeader.

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

Share via