Функция WinHttpWebSocketReceive (winhttp.h)

Статья
08/27/2023

Функция WinHttpWebSocketReceive получает данные из подключения WebSocket.

Синтаксис

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

Параметры

[in] hWebSocket

Тип: HINTERNET

Обработка в WebSocket.

[out] pvBuffer

Тип: PVOID

Указатель на буфер для получения данных.

[in] dwBufferLength

Тип: DWORD

Длина pvBuffer в байтах.

[out] pdwBytesRead

Тип: DWORD*

Указатель на DWORD , получающий число байтов, считанных из соединения в конце операции. Этот параметр устанавливается, только если WinHttpWebSocketReceive возвращает NO_ERROR и дескриптор был открыт в синхронном режиме.

[out] peBufferType

Тип: WINHTTP_WEB_SOCKET_BUFFER_TYPE*

Тип возвращаемого буфера. Это значение устанавливается, только если WinHttpWebSocketReceive возвращает NO_ERROR и дескриптор был открыт в синхронном режиме.

Возвращаемое значение

Тип: DWORD

NO_ERROR об успешном выполнении. В противном случае — код ошибки.

	Описание
ERROR_INVALID_OPERATION	Ожидается закрытие или получение, либо канал получения уже закрыт.
ERROR_INVALID_PARAMETER	Недопустимый параметр.
ERROR_WINHTTP_INVALID_SERVER_RESPONSE	С сервера получены недопустимые данные.
ERROR_WINHTTP_OPERATION_CANCELLED	Операция была отменена, так как для закрытия подключения был вызван WinHttpWebSocketClose .

Требования


Минимальная версия клиента	Windows 8 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 [только классические приложения]
Целевая платформа	Windows
Header	winhttp.h
Библиотека	Winhttp.lib
DLL	Winhttp.dll

Share via