Función WinHttpWebSocketReceive (winhttp.h)

Artículo
10/10/2023

La función WinHttpWebSocketReceive recibe datos de una conexión WebSocket.

Sintaxis

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

Parámetros

[in] hWebSocket

Tipo: HINTERNET

Identificador de un WebSocket.

[out] pvBuffer

Tipo: PVOID

Puntero a un búfer para recibir los datos.

[in] dwBufferLength

Tipo: DWORD

Longitud de pvBuffer, en bytes.

[out] pdwBytesRead

Tipo: DWORD*

Puntero a un DWORD que recibe el número de bytes leídos de la conexión al final de la operación. Esto solo se establece si WinHttpWebSocketReceive devuelve NO_ERROR y el identificador se abrió en modo sincrónico.

[out] peBufferType

Tipo: WINHTTP_WEB_SOCKET_BUFFER_TYPE*

Tipo de un búfer devuelto. Esto solo se establece si WinHttpWebSocketReceive devuelve NO_ERROR y el identificador se abrió en modo sincrónico.

Valor devuelto

Tipo: DWORD

NO_ERROR de éxito. De lo contrario, un código de error.

	Descripción
ERROR_INVALID_OPERATION	Un cierre o recepción está pendiente o el canal de recepción ya se ha cerrado.
ERROR_INVALID_PARAMETER	Si se devuelve este valor, significará que el parámetro en cuestión no es válido.
ERROR_WINHTTP_INVALID_SERVER_RESPONSE	Se recibieron datos no válidos del servidor.
ERROR_WINHTTP_OPERATION_CANCELLED	Se canceló la operación porque se llamó a WinHttpWebSocketClose para cerrar la conexión.

Requisitos


Cliente mínimo compatible	Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2012 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winhttp.h
Library	Winhttp.lib
Archivo DLL	Winhttp.dll