Fungsi WsShutdownSessionChannel (webservices.h)

Artikel
03/03/2024

Digunakan untuk memberi sinyal akhir pesan untuk saluran sesi.

Sintaks

HRESULT WsShutdownSessionChannel(
  [in]           WS_CHANNEL             *channel,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Parameter

[in] channel

Saluran sesi untuk dimatikan.

[in, optional] asyncContext

Informasi tentang cara memanggil fungsi secara asinkron, atau NULL jika memanggil secara sinkron.

[in, optional] error

Menentukan tempat informasi kesalahan tambahan harus disimpan jika fungsi gagal.

Mengembalikan nilai

Fungsi ini dapat mengembalikan salah satu nilai ini.

Menampilkan kode	Deskripsi
WS_E_INVALID_OPERATION	Ini dikembalikan jika saluran tidak dalam status WS_CHANNEL_STATE_OPEN .

Keterangan

Fungsi ini akan menunjukkan kepada pihak jarak jauh bahwa semua pesan telah dikirim untuk saluran.

Pihak jarak jauh dapat mendeteksi bahwa tidak ada lagi pesan yang tersedia di saluran dengan mencari nilai pengembalian WS_S_END saat menerima pesan. (Lihat Nilai Pengembalian Windows Web Services.) Namun, pesan juga dapat menjadi tidak tersedia jika pesan non-aplikasi difilter oleh saluran seperti yang dijelaskan dalam Gambaran Umum Lapisan Saluran. Penonaktifan sesi dapat dibedakan dari pemfilteran pesan dengan melacak apakah pesan sebelumnya diterima. Jika pesan sebelumnya diterima, sesi akan dimatikan.

Fungsi ini hanya berlaku untuk saluran yang dibuat dengan WS_CHANNEL_TYPE dengan sesi yang mendukung pengiriman pesan:

Saluran harus dalam status WS_CHANNEL_STATE_OPEN .

Jika fungsi ini berhasil, nilai properti WS_CHANNEL_PROPERTY_IS_SESSION_SHUT_DOWN akan TRUE.

Setelah saluran sesi dimatikan, mencoba mengirim pesan di saluran atau mencoba mematikan saluran akan kembali WS_E_INVALID_OPERATION.

Memanggil fungsi ini bersifat opsional. Saat saluran sesi ditutup menggunakan WsCloseChannel saat WS_CHANNEL_STATE_OPEN, saluran secara otomatis dimatikan sebagai bagian dari proses penutupan.

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