Fonction WinHttpWebSocketShutdown (winhttp.h)

La fonction WinHttpWebSocketShutdown envoie une image proche à un serveur WebSocket pour fermer le canal d’envoi, mais laisse le canal de réception ouvert.

Syntaxe

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

Paramètres

[in] hWebSocket

Type : HINTERNET

Gérer vers un WebSocket.

RemarqueWinHttpWebSocketShutdown 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_IO_PENDING	L’opération se termine de manière asynchrone.

Remarques

WinHttpWebSocketShutdown envoie un cadre fermé et empêche l’envoi de données supplémentaires via la connexion WebSocket. Il ne ferme pas le canal de réception. Utilisez WinHttpWebSocketClose lorsque vous souhaitez fermer complètement la connexion et empêcher toute opération de réception ultérieure.

L’application est responsable de la réception de l’image fermée du serveur (par le biais d’opérations de réception régulières).

Une fois WinHttpWebSocketShutdown appelé, l’application peut appeler WinHttpWebSocketClose si elle ne souhaite pas recevoir seule un cadre proche et le déléguer à la pile.

Configuration requise

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

WinHttpWebSocketClose