Функция WebSocketEndClientHandshake (websocket.h)
Функция WebSocketEndClientHandshake завершает подтверждение на стороне клиента.
Синтаксис
HRESULT WebSocketEndClientHandshake(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in] const PWEB_SOCKET_HTTP_HEADER pResponseHeaders,
[in] ULONG ulReponseHeaderCount,
[in, out, optional] ULONG *pulSelectedExtensions,
[in, out, optional] ULONG *pulSelectedExtensionCount,
[in, out, optional] ULONG *pulSelectedSubprotocol
);
Параметры
[in] hWebSocket
Тип: WEB_SOCKET_HANDLE
Дескриптор сеанса WebSocket, возвращенный предыдущим вызовом WebSocketCreateClientHandle.
[in] pResponseHeaders
Тип: const PWEB_SOCKET_HTTP_HEADER
Указатель на массив WEB_SOCKET_HTTP_HEADER структур, содержащих заголовки ответа, полученные приложением.
[in] ulReponseHeaderCount
Тип: ULONG
Количество заголовков ответов в pResponseHeaders.
[in, out, optional] pulSelectedExtensions
Тип: ULONG*
На входных данных указатель на массив, выделенный приложением. При успешном выводе указателя на массив чисел, представляющих расширения, выбранные сервером при подтверждении клиента и сервера. Это отсчитываемые от нуля индексы массива расширений, передаваемые в pszExtensions в WebSocketBeginClientHandshake.
[in, out, optional] pulSelectedExtensionCount
Тип: ULONG*
Во входных данных — количество расширений, выделенных в pulSelectedExtensions. Это значение должно быть по крайней мере равно числу, передаваемого в ulExtensionCount в WebSocketEndClientHandshake. При успешном выводе количество расширений, возвращенных в pulSelectedExtensions.
[in, out, optional] pulSelectedSubprotocol
Тип: ULONG*
При успешном выводе указатель на число, представляющее под-протокол, выбранный сервером во время подтверждения "клиент-сервер". Это число представляет собой отсчитываемый от нуля индекс массива подпротоколов, передаваемый в pszSubprotocols в WebSocketBeginClientHandshake.
Возвращаемое значение
Тип: HRESULT
Если функция выполняется успешно, она возвращает S_OK.
Если функция завершается сбоем, она возвращает один из следующих кодов или системной ошибки , определенный в WinError.h.
| Код возврата | Описание |
|---|---|
|
Данные протокола имеют недопустимый формат. |
|
Сервер не принимает ни один из вложенных протоколов, указанных приложением. |
|
Сервер не принимает расширения, указанные приложением. |
Комментарии
Эта функция должна вызываться для завершения подтверждения на стороне клиента после предыдущего вызова WebSocketBeginClientHandshake. После завершения подтверждения между клиентом и сервером приложение может использовать функции сеанса.
Требования
| Минимальная версия клиента | Windows 8 [только классические приложения] |
| Минимальная версия сервера | Windows Server 2012 [только классические приложения] |
| Целевая платформа | Windows |
| Header | websocket.h |
| Библиотека | Websocket.lib |
| DLL | Websocket.dll |