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

指向包含 WebSocket 会话相关属性 的WEB_SOCKET_PROPERTY 结构的数组的指针。

[in] ulPropertyCount

类型: ULONG

pProperties 中的属性数。

[out] phWebSocket

类型: WEB_SOCKET_HANDLE*

成功输出时,指针指向新分配的客户端 WebSocket 会话句柄。

返回值

类型: HRESULT

如果函数成功,则返回 S_OK

如果函数失败,它将返回 WinError.h 中定义的 系统错误代码

要求

要求
最低受支持的客户端 Windows 8 [仅限桌面应用]
最低受支持的服务器 Windows Server 2012 [仅限桌面应用]
目标平台 Windows
标头 websocket.h
Library Websocket.lib
DLL Websocket.dll

另请参阅

WEB_SOCKET_PROPERTY

WebSocketAbortHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle