WebSocketCreateServerHandle function (websocket.h)

The WebSocketCreateServerHandle function creates a server-side WebSocket session handle.

Syntax

HRESULT WebSocketCreateServerHandle(
  [in]  const PWEB_SOCKET_PROPERTY pProperties,
  [in]  ULONG                      ulPropertyCount,
  [out] WEB_SOCKET_HANDLE          *phWebSocket
);

Parameters

[in] pProperties

Type: const PWEB_SOCKET_PROPERTY

Pointer to an array of WEB_SOCKET_PROPERTY structures that contain WebSocket session-related properties.

[in] ulPropertyCount

Type: ULONG

Number of properties in pProperties.

[out] phWebSocket

Type: WEB_SOCKET_HANDLE*

On successful output, pointer to a newly allocated server-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

See also

WEB_SOCKET_PROPERTY

WebSocketAbortHandle

WebSocketCreateClientHandle

WebSocketDeleteHandle