WebSocketCreateClientHandle function
The WebSocketCreateClientHandle function creates a client-side WebSocket session handle.
Syntax
HRESULT WINAPI WebSocketCreateClientHandle(
_In_ const PWEB_SOCKET_PROPERTY pProperties,
_In_ ULONG ulPropertyCount,
_Out_ WEB_SOCKET_HANDLE *phWebSocket
);
Parameters
- pProperties [in]
-
Type: const PWEB_SOCKET_PROPERTY
Pointer to an array of WEB_SOCKET_PROPERTY structures that contain WebSocket session-related properties.
- ulPropertyCount [in]
-
Type: ULONG
Number of properties in pProperties.
- phWebSocket [out]
-
Type: WEB_SOCKET_HANDLE*
On successful output, pointer to a newly allocated client-side WebSocket session handle.
Return value
Type: HRESULT
If the function succeeds, it returns S_OK.
If the function fails, it returns a system error code defined in WinError.h.
Requirements
|
Minimum supported client | Windows 8 [desktop apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also