Função WinHttpWebSocketReceive (winhttp.h)

Artigo
10/10/2023

A função WinHttpWebSocketReceive recebe dados de uma conexão WebSocket.

Sintaxe

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

Manipule para um WebSocket.

[out] pvBuffer

Tipo: PVOID

Ponteiro para um buffer para receber os dados.

[in] dwBufferLength

Tipo: DWORD

Comprimento de pvBuffer, em bytes.

[out] pdwBytesRead

Tipo: DWORD*

Ponteiro para um DWORD que recebe o número de bytes lidos da conexão no final da operação. Isso será definido somente se WinHttpWebSocketReceive retornar NO_ERROR e o identificador tiver sido aberto no modo síncrono.

[out] peBufferType

Tipo: WINHTTP_WEB_SOCKET_BUFFER_TYPE*

O tipo de um buffer retornado. Isso só será definido se WinHttpWebSocketReceive retornar NO_ERROR e o identificador tiver sido aberto no modo síncrono.

Retornar valor

Tipo: DWORD

NO_ERROR sobre o sucesso. Caso contrário, um código de erro.

	Descrição
ERROR_INVALID_OPERATION	Um fechamento ou recebimento está pendente ou o canal de recebimento já foi fechado.
ERROR_INVALID_PARAMETER	Um parâmetro é inválido.
ERROR_WINHTTP_INVALID_SERVER_RESPONSE	Dados inválidos foram recebidos do servidor.
ERROR_WINHTTP_OPERATION_CANCELLED	A operação foi cancelada porque WinHttpWebSocketClose foi chamado para fechar a conexão.

Requisitos


Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winhttp.h
Biblioteca	Winhttp.lib
DLL	Winhttp.dll