WinHttpWebSocketQueryCloseStatus, fonction (winhttp.h)

Article
03/04/2024

La fonction WinHttpWebSocketQueryCloseStatus récupère les status de fermeture envoyées par un serveur.

Syntaxe

WINHTTPAPI DWORD WinHttpWebSocketQueryCloseStatus(
  [in]  HINTERNET hWebSocket,
  [out] USHORT    *pusStatus,
  [out] PVOID     pvReason,
  [in]  DWORD     dwReasonLength,
  [out] DWORD     *pdwReasonLengthConsumed
);

Paramètres

[in] hWebSocket

Type : HINTERNET

Handle vers un WebSocket

[out] pusStatus

Type : USHORT*

Pointeur vers un code status fermé qui sera rempli lors du retour. Consultez WINHTTP_WEB_SOCKET_CLOSE_STATUS pour connaître les valeurs possibles.

[out] pvReason

Type : PVOID

Pointeur vers une mémoire tampon qui recevra une raison de fermeture au retour.

[in] dwReasonLength

Type : DWORD

Longueur de la mémoire tampon pvReason , en octets.

[out] pdwReasonLengthConsumed

Type : DWORD*

Nombre d’octets consommés. Si pvReason a la valeur NULL et que dwReasonLength a la valeur 0, pdwReasonLengthConsumed contiendra la taille de la mémoire tampon qui doit être allouée par l’application appelante.

Valeur retournée

Type : DWORD

NO_ERROR sur le succès. Sinon, code d’erreur.

	Description
ERROR_INSUFFICIENT_BUFFER	Il n’y a pas assez d’espace dans pvReason pour écrire toute la raison proche.
ERROR_INVALID_OPERATION	Aucune trame rapprochée n’a encore été reçue.
ERROR_INVALID_PARAMETER	Un paramètre n'est pas valide.

Remarques

Appelez WinHttpWebSocketQueryCloseStatus uniquement après la réussite de WinHttpWebSocketClose ou si WinHttpWebSocketReceive retourne WINHTTP_WEB_SOCKET_CLOSE_BUFFER_TYPE.

pdwReasonLengthConsumed ne sera jamais supérieur à 123. Ainsi, l’allocation d’une mémoire tampon avec au moins 123 garantit que ERROR_INSUFFICIENT_BUFFER ne sera jamais retourné.

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

WinHttpWebSocketClose

WinHttpWebSocketReceive

Partager via