Compartilhar via


Função WebSocketCreateClientHandle (websocket.h)

A função WebSocketCreateClientHandle cria um identificador de sessão WebSocket do lado do cliente.

Sintaxe

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

Parâmetros

[in] pProperties

Tipo: const PWEB_SOCKET_PROPERTY

Ponteiro para uma matriz de estruturas de WEB_SOCKET_PROPERTY que contêm propriedades relacionadas à sessão WebSocket.

[in] ulPropertyCount

Tipo: ULONG

Número de propriedades em pProperties.

[out] phWebSocket

Tipo: WEB_SOCKET_HANDLE*

Na saída bem-sucedida, ponteiro para um identificador de sessão WebSocket do lado do cliente recém-alocado.

Retornar valor

Tipo: HRESULT

Se a função for bem-sucedida, ela retornará S_OK.

Se a função falhar, ela retornará um código de erro do sistema definido em WinError.h.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho websocket.h
Biblioteca Websocket.lib
DLL Websocket.dll

Confira também

WEB_SOCKET_PROPERTY

WebSocketAbortHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle