Fonction WinHttpWebSocketClose (winhttp.h)

Article
03/04/2024

La fonction WinHttpWebSocketClose ferme une connexion WebSocket.

Syntaxe

WINHTTPAPI DWORD WinHttpWebSocketClose(
  [in]           HINTERNET hWebSocket,
  [in]           USHORT    usStatus,
  [in, optional] PVOID     pvReason,
  [in]           DWORD     dwReasonLength
);

Paramètres

[in] hWebSocket

Type : HINTERNET

Gérer vers un WebSocket.

RemarqueWinHttpWebSocketClose ne ferme pas ce handle. Pour fermer le handle, appelez WinHttpCloseHandle sur hWebSocket une fois qu’il n’est plus nécessaire.

[in] usStatus

Type : USHORT

Code status fermé. Consultez WINHTTP_WEB_SOCKET_CLOSE_STATUS pour connaître les valeurs possibles.

[in, optional] pvReason

Type : PVOID

Raison détaillée de la fermeture.

[in] dwReasonLength

Type : DWORD

Longueur de pvReason, en octets.

Si pvReason a la valeur NULL, cela doit être 0. Cette valeur doit être comprise entre 0 et 123.

Valeur retournée

Type : DWORD

À l’exception suivante, tous les codes d’erreur indiquent que la connexion TCP sous-jacente a été abandonnée.

	Description
ERROR_INVALID_OPERATION	Une fermeture ou un envoi est en attente.
ERROR_INVALID_PARAMETER	Un paramètre n'est pas valide.
ERROR_INVALID_SERVER_RESPONSE	Des données non valides ont été reçues du serveur.

Remarques

WinHttpWebSocketClose ferme complètement une connexion WebSocket. Pour fermer le canal d’envoi tout en laissant le canal de réception ouvert, utilisez WinHttpWebSocketShutdown.

Il est possible de recevoir une trame rapprochée pendant les opérations de réception régulières. Dans ce cas, WinHttpWebSocketClose envoie également un cadre proche.

Le minuteur de fermeture peut être défini par la propriété WINHTTP_OPTION_WEB_SOCKET_CLOSE_TIMEOUT. La valeur par défaut est 10 secondes.

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	winhttp.h
Bibliothèque	Winhttp.lib
DLL	Winhttp.dll

Voir aussi

WINHTTP_WEB_SOCKET_CLOSE_STATUS

WinHttpCloseHandle

WinHttpWebSocketShutdown

Partager via