WebSocketAbortHandle 函式 (websocket.h)

WebSocketAbortHandle 函式會中止 WebSocketCreateClientHandle 或 WebSocketCreateServerHandle 所建立的 WebSocket 會話句柄。

語法

void WebSocketAbortHandle(
  [in] WEB_SOCKET_HANDLE hWebSocket
);

參數

[in] hWebSocket

類型： WEB_SOCKET_HANDLE

先前呼叫 WebSocketCreateClientHandle 或 WebSocketCreateServerHandle 所傳回的 WebSocket 會話句柄。

傳回值

如果函式成功，它會傳回 S_OK。

如果函式失敗，它會傳回 WinError.h 中定義的 系統錯誤碼 。

備註

WebSocketAbortHandle 中止 WEB_SOCKET_HANDLE 會話句柄，而對 WebSocketSend 或 WebSocketReceive 的任何呼叫都會在呼叫時傳回錯誤。 如果 WebSocket 交握尚未完成且會話句柄尚未初始化，則 WebSocketAbortHandle 是無作業。 任何使用 WebSocketSend 或 WebSocketReceive 排入佇列的傳送/接收作業都已準備好使用 WebSocketGetAction 來處理，但嘗試使用中止的句柄排入其他作業佇列將會導致錯誤。

規格需求

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

另請參閱

WebSocketCreateClientHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle