Функция WebSocketSend (websocket.h)

Статья
08/27/2023

Функция WebSocketSend добавляет операцию отправки в очередь операций компонента протокола.

Синтаксис

HRESULT WebSocketSend(
  [in]           WEB_SOCKET_HANDLE      hWebSocket,
  [in]           WEB_SOCKET_BUFFER_TYPE BufferType,
  [in, optional] WEB_SOCKET_BUFFER      *pBuffer,
  [in, optional] PVOID                  Context
);

Параметры

[in] hWebSocket

Тип: WEB_SOCKET_HANDLE

Дескриптор сеанса WebSocket, возвращенный предыдущим вызовом WebSocketCreateClientHandle или WebSocketCreateServerHandle.

[in] BufferType

Тип: WEB_SOCKET_BUFFER_TYPE

Тип данных буфера WebSocket для отправки в pBuffer.

[in, optional] pBuffer

Тип: WEB_SOCKET_BUFFER*

Указатель на массив WEB_SOCKET_BUFFER структур, содержащих данные буфера WebSocket для отправки. Если bufferType имеет значение WEB_SOCKET_PING_PONG_BUFFER_TYPE или WEB_SOCKET_UNSOLICITED_PONG_BUFFER_TYPE, pBuffer должен иметь значение NULL.

Примечание После того как WEB_SOCKET_INDICATE_SEND_COMPLETE возвращается webSocketGetAction для этого действия, можно освободить указатель на память с помощью pBuffer .

[in, optional] Context

Тип: PVOID

Указатель на дескриптор контекста приложения, который будет возвращен последующим вызовом WebSocketGetAction.

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

Тип: HRESULT

Если функция завершается успешно, она возвращает S_OK.

Если функция завершается сбоем, она возвращает один из следующих кодов или системной ошибки , определенных в WinError.h.

Код возврата	Описание
E_INVALID_PROTOCOL_OPERATION	Протокол выполнил недопустимую операцию.

Требования

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