Fungsi WinHttpWebSocketClose (winhttp.h)

Artikel
03/13/2024

Fungsi WinHttpWebSocketClose menutup koneksi WebSocket.

Sintaks

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

Parameter

[in] hWebSocket

Jenis: HINTERNET

Menangani ke WebSocket.

CatatanWinHttpWebSocketClose 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.

Nilai kembali

Jenis: DWORD

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

	Deskripsi
ERROR_INVALID_OPERATION	Penutupan atau pengiriman tertunda.
ERROR_INVALID_PARAMETER	Parameter tidak valid.
ERROR_INVALID_SERVER_RESPONSE	Data tidak valid diterima dari server.

Keterangan

WinHttpWebSocketClose sepenuhnya menutup koneksi WebSocket. Untuk menutup saluran kirim saat masih membiarkan saluran terima terbuka, gunakan WinHttpWebSocketShutdown.

Dimungkinkan untuk menerima bingkai dekat selama operasi penerimaan reguler. Dalam hal ini, WinHttpWebSocketClose juga akan mengirim bingkai dekat.

Timer penutupan dapat diatur oleh properti WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT. Defaultnya adalah 10 detik.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 8 [khusus 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

WinHttpWebSocketShutdown

Bagikan melalui