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

Статья
03/13/2024

Функция WebSocketCompleteAction завершает действие, запущенное WebSocketGetAction.

Синтаксис

void WebSocketCompleteAction(
  [in] WEB_SOCKET_HANDLE hWebSocket,
  [in] PVOID             pvActionContext,
  [in] ULONG             ulBytesTransferred
);

Параметры

[in] hWebSocket

Тип: WEB_SOCKET_HANDLE

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

[in] pvActionContext

Тип: PVOID

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

[in] ulBytesTransferred

Тип: ULONG

Количество байтов, переданных для действий WEB_SOCKET_SEND_TO_NETWORK_ACTION или WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION . Это значение должно быть равно 0 для всех остальных действий.

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

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

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

WEB_SOCKET_SEND_TO_NETWORK_ACTION: если значение ulBytesTransferred отличается от суммы всех длин буферов, возвращенных из WebSocketGetAction , текущее действие отправки отменяется и следующий вызов WebSocketGetAction вернет WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION даже если не все буферы, переданные в WebSocketSend , были обработаны.
WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION: если значение ulBytesTransferred равно 0, текущее действие получения отменяется и следующий вызов WebSocketGetAction вернет WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION даже если были обработаны не все буферы, переданные в WebSocketReceive .

Требования

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

См. также раздел

WEB_SOCKET_ACTION

WebSocketGetAction

Поделиться через