Fungsi WsCheckMustUnderstandHeaders (webservices.h)

Artikel
03/13/2024

Memverifikasi bahwa header yang ditentukan dipahami oleh penerima.

Catatan Fungsi ini harus dipanggil setelah semua header dibaca untuk pesan yang diterima.

Sintaks

HRESULT WsCheckMustUnderstandHeaders(
  [in]           WS_MESSAGE *message,
  [in, optional] WS_ERROR   *error
);

Parameter

[in] message

Arahkan ke struktur WS_MESSAGE yang berisi header yang akan dipahami.

[in, optional] error

Penunjuk ke struktur WS_ERROR tempat informasi kesalahan tambahan disimpan jika fungsi gagal.

Mengembalikan nilai

Jika fungsi berhasil, fungsi akan mengembalikan NO_ERROR; jika tidak, kode kesalahan HRESULT akan dikembalikan.

Menampilkan kode	Deskripsi
WS_E_INVALID_OPERATION	Pesan tidak dalam status yang benar. Untuk informasi lebih lanjut, lihat bagian Keterangan.
WS_E_INVALID_FORMAT	Validasi gagal, atau pesan tidak terbentuk dengan benar.
E_INVALIDARG	Satu atau beberapa argumen tidak valid.
E_OUTOFMEMORY	Tidak cukup memori untuk menyelesaikan operasi.
Kesalahan Lain	Fungsi ini dapat mengembalikan kesalahan lain yang tidak tercantum di atas.

Keterangan

Karena kumpulan header dapat diperluas, perlu untuk menentukan apakah pesan telah cukup dipahami untuk diproses. Oleh karena itu, pengirim dapat menggunakan fungsi ini untuk menunjukkan header mana yang harus dipahami, header mana yang dapat diperlakukan sebagai opsional atau informasi.

Header alamat standar, seperti yang didefinisikan dalam WS_HEADER_TYPE, secara otomatis diasumsikan dipahami, bahkan jika mereka tidak pernah membaca dengan memanggil WsGetHeader.

Header kustom yang ditentukan aplikasi yang dibaca oleh WsGetCustomHeader juga diasumsikan dipahami. Memanggil WsGetCustomHeader akan secara otomatis menandai header tertentu sebagai dipahami.

Untuk header lain yang diproses oleh aplikasi, aplikasi harus secara eksplisit menandai header sebagaimana dipahami dengan memanggil WsMarkHeaderAsUnderstood. Jika tidak, header dianggap tidak dipahami.

Fungsi ini harus dipanggil setelah semua header dibaca untuk pesan yang diterima. Pengecualian untuk harus memanggil fungsi ini adalah kasus perantara yang meneruskan pesan ke simpul lain tanpa mengubah identitasnya (ID pesan), karena simpul akhir akan melakukan pemeriksaan.

Fungsi akan gagal jika salah satu header yang ditentukan tidak dipahami. Jika objek kesalahan diberikan ke fungsi, objek akan diisi dengan informasi yang dapat digunakan untuk mengirim kesalahan (lihat WsCreateFaultFromError).

Pesan harus dalam status WS_MESSAGE_STATE_READING.

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