Função WebSocketAbortHandle (websocket.h)
A função WebSocketAbortHandle anula um identificador de sessão WebSocket criado por WebSocketCreateClientHandle ou WebSocketCreateServerHandle.
Sintaxe
void WebSocketAbortHandle(
[in] WEB_SOCKET_HANDLE hWebSocket
);
Parâmetros
[in] hWebSocket
Tipo: WEB_SOCKET_HANDLE
Identificador de sessão WebSocket retornado por uma chamada anterior para WebSocketCreateClientHandle ou WebSocketCreateServerHandle.
Retornar valor
Se a função for bem-sucedida, ela retornará S_OK.
Se a função falhar, ela retornará um código de erro do sistema definido em WinError.h.
Comentários
WebSocketAbortHandle anula um identificador de sessão WEB_SOCKET_HANDLE e todas as chamadas para WebSocketSend ou WebSocketReceive retornarão um erro quando chamado com um identificador anulado. WebSocketAbortHandle será um no-op se o handshake do WebSocket não tiver sido concluído e o identificador de sessão não tiver sido inicializado. Todas as operações de envio/recebimento que foram enfileiradas usando WebSocketSend ou WebSocketReceive estarão prontas para serem processadas usando WebSocketGetAction, mas as tentativas de enfileirar operações adicionais usando o identificador anulado resultarão em erro.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 8 [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2012 [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | websocket.h |
| Biblioteca | Websocket.lib |
| DLL | Websocket.dll |