Функция WebSocketCreateClientHandle (websocket.h)
Функция WebSocketCreateClientHandle создает клиентский дескриптор сеанса WebSocket.
Синтаксис
HRESULT WebSocketCreateClientHandle(
[in] const PWEB_SOCKET_PROPERTY pProperties,
[in] ULONG ulPropertyCount,
[out] WEB_SOCKET_HANDLE *phWebSocket
);
Параметры
[in] pProperties
Тип: const PWEB_SOCKET_PROPERTY
Указатель на массив WEB_SOCKET_PROPERTY структур, содержащих свойства, связанные с сеансом WebSocket.
[in] ulPropertyCount
Тип: ULONG
Число свойств в pProperties.
[out] phWebSocket
Тип: WEB_SOCKET_HANDLE*
При успешном выводе указателя на только что выделенный дескриптор сеанса WebSocket на стороне клиента.
Возвращаемое значение
Тип: HRESULT
Если функция завершается успешно, она возвращает S_OK.
Если функция завершается сбоем, она возвращает код системной ошибки , определенный в WinError.h.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows 8 [только классические приложения] |
| Минимальная версия сервера | Windows Server 2012 [только классические приложения] |
| Целевая платформа | Windows |
| Header | websocket.h |
| Библиотека | Websocket.lib |
| DLL | Websocket.dll |