Fungsi WinHttpWebSocketShutdown (winhttp.h)

Artikel
08/27/2023

Fungsi WinHttpWebSocketShutdown mengirimkan bingkai dekat ke server WebSocket untuk menutup saluran pengiriman, tetapi membiarkan saluran terima terbuka.

Sintaks

WINHTTPAPI DWORD WinHttpWebSocketShutdown(
  [in]           HINTERNET hWebSocket,
  [in]           USHORT    usStatus,
  [in, optional] PVOID     pvReason,
  [in]           DWORD     dwReasonLength
);

Parameter

[in] hWebSocket

Jenis: HINTERNET

Menangani ke WebSocket.

CatatanWinHttpWebSocketShutdown tidak menutup handel ini. Untuk menutup handel, panggil WinHttpCloseHandle di hWebSocket setelah tidak lagi diperlukan.

[in] usStatus

Jenis: USHORT

Kode status penutupan. Lihat WINHTTP_WEB_SOCKET_CLOSE_STATUS untuk nilai yang mungkin.

[in, optional] pvReason

Jenis: PVOID

Alasan terperinci untuk penutupan.

[in] dwReasonLength

Jenis: DWORD

Panjang pvReason, dalam byte.

Jika pvReason adalah NULL, ini harus 0. Nilai ini harus dalam rentang 0 hingga 123.

Mengembalikan nilai

Jenis: DWORD

Dengan pengecualian berikut, semua kode kesalahan menunjukkan bahwa koneksi TCP yang mendasar telah dibatalkan.

	Deskripsi
ERROR_IO_PENDING	Operasi akan selesai secara asinkron.

Keterangan

WinHttpWebSocketShutdown mengirimkan bingkai dekat dan mencegah data tambahan dikirim melalui koneksi WebSocket. Ini tidak menutup saluran terima. Gunakan WinHttpWebSocketClose saat Anda ingin sepenuhnya menutup koneksi dan mencegah operasi penerimaan berikutnya.

Aplikasi ini bertanggung jawab untuk menerima bingkai dekat dari server (melalui operasi penerimaan reguler).

Setelah WinHttpWebSocketShutdown dipanggil, aplikasi dapat memanggil WinHttpWebSocketClose jika tidak ingin menerima bingkai dekat sendiri dan mendelegasikannya ke tumpukan.

Persyaratan


Klien minimum yang didukung	Windows 8 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2012 [hanya aplikasi desktop]
Target Platform	Windows
Header	winhttp.h
Pustaka	Winhttp.lib
DLL	Winhttp.dll

Lihat juga

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketClose

Bagikan melalui