WebSocketAbortHandle-Funktion (websocket.h)
Die WebSocketAbortHandle-Funktion bricht ein WebSocket-Sitzungshandle ab, das von WebSocketCreateClientHandle oder WebSocketCreateServerHandle erstellt wurde.
Syntax
void WebSocketAbortHandle(
[in] WEB_SOCKET_HANDLE hWebSocket
);
Parameter
[in] hWebSocket
Typ: WEB_SOCKET_HANDLE
WebSocket-Sitzungshandle, das von einem vorherigen Aufruf von WebSocketCreateClientHandle oder WebSocketCreateServerHandle zurückgegeben wurde.
Rückgabewert
Wenn die Funktion erfolgreich ist, gibt sie S_OK zurück.
Wenn die Funktion fehlschlägt, gibt sie einen in WinError.h definierten Systemfehlercode zurück.
Hinweise
WebSocketAbortHandle bricht ein WEB_SOCKET_HANDLE Sitzungshandle ab, und alle Aufrufe von WebSocketSend oder WebSocketReceive geben einen Fehler zurück, wenn sie mit einem abgebrochenen Handle aufgerufen werden. WebSocketAbortHandle ist ein no-op, wenn der WebSocket-Handshake nicht abgeschlossen wurde und das Sitzungshandle nicht initialisiert wurde. Alle Sende-/Empfangsvorgänge, die mithilfe von WebSocketSend oder WebSocketReceive in die Warteschlange gestellt wurden, können mithilfe von WebSocketGetAction verarbeitet werden. Versuche, zusätzliche Vorgänge mithilfe des abgebrochenen Handles in die Warteschlange zu stellen, führen jedoch zu einem Fehler.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows 8 [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2012 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | websocket.h |
| Bibliothek | Websocket.lib |
| DLL | Websocket.dll |