WinHttpWebSocketReceive, fonction (winhttp.h)

Article
10/10/2023

La fonction WinHttpWebSocketReceive reçoit des données d’une connexion WebSocket.

Syntaxe

WINHTTPAPI DWORD WinHttpWebSocketReceive(
  [in]  HINTERNET                      hWebSocket,
  [out] PVOID                          pvBuffer,
  [in]  DWORD                          dwBufferLength,
  [out] DWORD                          *pdwBytesRead,
  [out] WINHTTP_WEB_SOCKET_BUFFER_TYPE *peBufferType
);

Paramètres

[in] hWebSocket

Type : HINTERNET

Handle vers un WebSocket.

[out] pvBuffer

Type : PVOID

Pointeur vers une mémoire tampon pour recevoir les données.

[in] dwBufferLength

Type : DWORD

Longueur de pvBuffer, en octets.

[out] pdwBytesRead

Type : DWORD*

Pointeur vers un DWORD qui reçoit le nombre d’octets lus à partir de la connexion à la fin de l’opération. Ce paramètre est défini uniquement si WinHttpWebSocketReceive retourne NO_ERROR et que le handle a été ouvert en mode synchrone.

[out] peBufferType

Type : WINHTTP_WEB_SOCKET_BUFFER_TYPE*

Type d’une mémoire tampon retournée. Ce paramètre est défini uniquement si WinHttpWebSocketReceive retourne NO_ERROR et que le handle a été ouvert en mode synchrone.

Valeur retournée

Type : DWORD

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

	Description
ERROR_INVALID_OPERATION	Une fermeture ou une réception est en attente, ou le canal de réception a déjà été fermé.
ERROR_INVALID_PARAMETER	Un paramètre n'est pas valide.
ERROR_WINHTTP_INVALID_SERVER_RESPONSE	Des données non valides ont été reçues du serveur.
ERROR_WINHTTP_OPERATION_CANCELLED	L’opération a été annulée car WinHttpWebSocketClose a été appelé pour fermer la connexion.

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

Partager via