WebSocketDeleteHandle-Funktion (websocket.h)

Die WebSocketDeleteHandle-Funktion löscht ein WebSocket-Sitzungshandle, das von WebSocketCreateClientHandle oder WebSocketCreateServerHandle erstellt wurde.

Syntax

void WebSocketDeleteHandle(
  [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, wird S_OK zurückgegeben.

Wenn die Funktion fehlschlägt, gibt sie einen in WinError.h definierten Systemfehlercode zurück.

Hinweise

Jede Verwendung eines gelöschten WEB_SOCKET_HANDLE Sitzungshandles kann zu einer Zugriffsverletzung führen.

Bevor eine Anwendung ein Sitzungshandle löscht, muss sie sicherstellen, dass alle Vorgänge verarbeitet wurden. Anwendungen können WebSocketAbortHandle verwenden, um alle Vorgänge in der Warteschlange abzubrechen, bevor WebSocketDeleteHandle aufgerufen wird.

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

Weitere Informationen

WebSocketAbortHandle

WebSocketCreateClientHandle

WebSocketCreateServerHandle