WinHttpWebSocketClose 函式 (winHTTP.h)

  • 發行項

WinHttpWebSocketClose 函式會關閉 WebSocket 連線。

語法

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

參數

[in] hWebSocket

類型： HINTERNET

WebSocket 的句柄。

注意WinHttpWebSocketClose 不會關閉此句柄。 若要關閉句柄，一旦不再需要，請在 hWebSocket 上呼叫 WinHttpCloseHandle。

 

[in] usStatus

類型： USHORT

關閉狀態代碼。 如需可能的值 ，請參閱WINHTTP_WEB_SOCKET_CLOSE_STATUS 。

[in, optional] pvReason

類型： PVOID

關閉的詳細原因。

[in] dwReasonLength

類型： DWORD

pvReason 的長度，以位元組為單位。

如果 pvReason 為 NULL，這必須是 0。 此值必須介於 0 到 123 的範圍內。

傳回值

類型： DWORD

在下列例外狀況下，所有錯誤碼都表示基礎 TCP 連線已中止。

Description
ERROR_INVALID_OPERATION
 關閉或傳送擱置中。
ERROR_INVALID_PARAMETER
 有一個參數無效。
ERROR_INVALID_SERVER_RESPONSE
 從伺服器收到無效的數據。

備註

WinHttpWebSocketClose 會完全關閉 WebSocket 連線。 若要在仍保持接收通道開啟時關閉傳送通道，請使用 WinHttpWebSocketShutdown。

在一般接收作業期間，可以接收接近的畫面。 在此情況下， WinHttpWebSocketClose 也會傳送接近的畫面。

關閉定時器可由 屬性 設定WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT。 預設值是 10 秒。

規格需求

需求 值
最低支援的用戶端 Windows 8 [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2012 [僅限傳統型應用程式]
目標平台 Windows
標頭 winhttp.h
程式庫 Winhttp.lib
Dll Winhttp.dll

另請參閱

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketShutdown