WinHttpWebSocketShutdown 函式 (winHTTP.h)

WinHttpWebSocketShutdown函式會將關閉框架傳送至 WebSocket 伺服器以關閉傳送通道，但讓接收通道保持開啟狀態。

語法

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

參數

[in] hWebSocket

類型： HINTERNET

WebSocket 的控制碼。

注意WinHttpWebSocketShutdown 不會關閉此控制碼。 若要關閉控制碼，一旦不再需要，請在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 連線已中止。

	描述
ERROR_IO_PENDING	作業會以非同步方式完成。

備註

WinHttpWebSocketShutdown 會傳送關閉畫面，並防止透過 WebSocket 連線傳送其他資料。 它不會關閉接收通道。 當您想要完全關閉連線，並防止任何後續的接收作業時，請使用 WinHttpWebSocketClose 。

應用程式會負責透過一般接收作業) 從伺服器接收關閉框架 (。

呼叫 WinHttpWebSocketShutdown 之後，如果應用程式不想要自行接收接近的框架，並將它委派給堆疊，應用程式就可以呼叫 WinHttpWebSocketClose 。

規格需求

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

另請參閱

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketClose