Fonction WebSocketAbortHandle (websocket.h)
La fonction WebSocketAbortHandle supprime un handle de session WebSocket créé par WebSocketCreateClientHandle ou WebSocketCreateServerHandle.
Syntaxe
void WebSocketAbortHandle(
[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
WebSocketAbortHandle abandonne un handle de session WEB_SOCKET_HANDLE et tous les appels à WebSocketSend ou WebSocketReceive retournent une erreur lorsqu’ils sont appelés avec un handle abandonné. WebSocketAbortHandle est une opération non opérationnelle si la liaison WebSocket n’a pas été terminée et si le handle de session n’a pas été initialisé. Toutes les opérations d’envoi/réception qui ont été mises en file d’attente à l’aide de WebSocketSend ou WebSocketReceive seront prêtes à être traitées à l’aide de WebSocketGetAction, mais les tentatives de mise en file d’attente d’opérations supplémentaires à l’aide du handle abandonné entraînent une erreur.
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 |