Partager via


Fonction WebSocketDeleteHandle (websocket.h)

La fonction WebSocketDeleteHandle supprime un handle de session WebSocket créé par WebSocketCreateClientHandle ou WebSocketCreateServerHandle.

Syntaxe

void WebSocketDeleteHandle(
  [in] WEB_SOCKET_HANDLE hWebSocket
);

Paramètres

[in] hWebSocket

Type : WEB_SOCKET_HANDLE

Handle de session WebSocket retourné par un appel précédent à WebSocketCreateClientHandle ou WebSocketCreateServerHandle.

Valeur retournée

Si la fonction réussit, elle retourne S_OK.

Si la fonction échoue, elle retourne un code d’erreur système défini dans WinError.h.

Remarques

Toute utilisation d’un handle de session WEB_SOCKET_HANDLE supprimé peut entraîner une violation d’accès.

Avant de supprimer un handle de session, une application doit s’assurer que toutes les opérations ont été traitées. Les applications peuvent utiliser WebSocketAbortHandle pour abandonner toutes les opérations en file d’attente avant d’appeler WebSocketDeleteHandle.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2012 [applications de bureau uniquement]
Plateforme cible Windows
En-tête websocket.h
Bibliothèque Websocket.lib
DLL Websocket.dll

Voir aussi

WebSocketAbortHandle

WebSocketCreateClientHandle

WebSocketCreateServerHandle