Функция WebSocketAbortHandle (websocket.h)

Функция WebSocketAbortHandle прерывает дескриптор сеанса WebSocket , созданный WebSocketCreateClientHandle или WebSocketCreateServerHandle.

Синтаксис

void WebSocketAbortHandle(
  [in] WEB_SOCKET_HANDLE hWebSocket
);

Параметры

[in] hWebSocket

Тип: WEB_SOCKET_HANDLE

Дескриптор сеанса WebSocket, возвращенный предыдущим вызовом WebSocketCreateClientHandle или WebSocketCreateServerHandle.

Возвращаемое значение

Если функция выполняется успешно, она возвращает S_OK.

Если функция завершается сбоем, она возвращает код системной ошибки , определенный в WinError.h.

Комментарии

WebSocketAbortHandle прерывает WEB_SOCKET_HANDLE дескриптор сеанса, и все вызовы WebSocketSend или WebSocketReceive будут возвращать ошибку при вызове с прерванным дескриптором. WebSocketAbortHandle не выполняется, если подтверждение WebSocket не завершено и дескриптор сеанса не инициализирован. Все операции отправки и получения, которые были поставлены в очередь с помощью WebSocketSend или WebSocketReceive , будут готовы к обработке с помощью WebSocketGetAction, но попытки постановки в очередь дополнительных операций с помощью прерванного дескриптора приведут к ошибке.

Требования

Требование	Значение
Минимальная версия клиента	Windows 8 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 [только классические приложения]
Целевая платформа	Windows
Header	websocket.h
Библиотека	Websocket.lib
DLL	Websocket.dll

См. также раздел

WebSocketCreateClientHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle