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 时，任何对 WebSocketSend 或 WebSocketReceive 的调用都将返回错误。 如果 WebSocket 握手尚未完成且会话句柄尚未初始化，则 WebSocketAbortHandle 为 no-op。 使用 WebSocketSend 或 WebSocketReceive 排队的任何发送/接收操作都将准备好使用 WebSocketGetAction 进行处理，但尝试使用中止的句柄将其他操作排队将导致错误。

要求

另请参阅

WebSocketCreateClientHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle