Funzione WebSocketAbortHandle (websocket.h)
La funzione WebSocketAbortHandle interrompe un handle di sessione WebSocket creato da WebSocketCreateClientHandle o WebSocketCreateServerHandle.
Sintassi
void WebSocketAbortHandle(
[in] WEB_SOCKET_HANDLE hWebSocket
);
Parametri
[in] hWebSocket
Tipo: WEB_SOCKET_HANDLE
Handle di sessione WebSocket restituito da una chiamata precedente a WebSocketCreateClientHandle o WebSocketCreateServerHandle.
Valore restituito
Se la funzione ha esito positivo, restituisce S_OK.
Se la funzione ha esito negativo, restituisce un codice di errore di sistema definito in WinError.h.
Commenti
WebSocketAbortHandle interrompe un handle di sessione WEB_SOCKET_HANDLE e tutte le chiamate a WebSocketSend o WebSocketReceive restituiranno un errore quando viene chiamato con un handle interrotto. WebSocketAbortHandle è un no-op se l'handshake WebSocket non è stato completato e l'handle di sessione non è stato inizializzato. Tutte le operazioni di invio/ricezione accodate tramite WebSocketSend o WebSocketReceive saranno pronte per l'elaborazione tramite WebSocketGetAction, ma i tentativi di accodare operazioni aggiuntive usando l'handle interrotto genereranno un errore.
Requisiti
| Requisito | Valore |
|---|---|
| Client minimo supportato | Windows 8 [solo app desktop] |
| Server minimo supportato | Windows Server 2012 [solo app desktop] |
| Piattaforma di destinazione | Windows |
| Intestazione | websocket.h |
| Libreria | Websocket.lib |
| DLL | Websocket.dll |