Función WebSocketAbortHandle (websocket.h)

La función WebSocketAbortHandle anula un identificador de sesión de WebSocket creado por WebSocketCreateClientHandle o WebSocketCreateServerHandle.

Sintaxis

VOID WebSocketAbortHandle(
  [in] WEB_SOCKET_HANDLE hWebSocket
);

Parámetros

[in] hWebSocket

Tipo: WEB_SOCKET_HANDLE

Identificador de sesión de WebSocket devuelto por una llamada anterior a WebSocketCreateClientHandle o WebSocketCreateServerHandle.

Valor devuelto

Si la función se realiza correctamente, devuelve S_OK.

Si se produce un error en la función, devuelve un código de error del sistema definido en WinError.h.

Comentarios

WebSocketAbortHandle anula un identificador de sesión de WEB_SOCKET_HANDLE y cualquier llamada a WebSocketSend o WebSocketReceive devolverá un error cuando se llama con un identificador anulado. WebSocketAbortHandle es una operación no operativa si no se ha completado el protocolo de enlace de WebSocket y no se ha inicializado el identificador de sesión. Las operaciones de envío y recepción que se ponen en cola mediante WebSocketSend o WebSocketReceive estarán listas para procesarse mediante WebSocketGetAction, pero los intentos de poner en cola operaciones adicionales mediante el identificador anulado producirán un error.

Requisitos

Consulte también

WebSocketCreateClientHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle