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
程式庫	Websocket.lib
Dll	Websocket.dll

另請參閱

WEB_SOCKET_PROPERTY

WebSocketAbortHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle