Fonction WebSocketCreateClientHandle (websocket.h)

La fonction WebSocketCreateClientHandle crée un handle de session WebSocket côté client.

Syntaxe

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

Paramètres

[in] pProperties

Type : const PWEB_SOCKET_PROPERTY

Pointeur vers un tableau de structures WEB_SOCKET_PROPERTY qui contiennent des propriétés liées à la session WebSocket.

[in] ulPropertyCount

Type : ULONG

Nombre de propriétés dans pProperties.

[out] phWebSocket

Type : WEB_SOCKET_HANDLE*

En cas de sortie réussie, pointez vers un handle de session WebSocket côté client nouvellement alloué.

Valeur retournée

Type : HRESULT

Si la fonction réussit, elle retourne S_OK.

Si la fonction échoue, elle retourne un code d’erreur système défini dans WinError.h.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	websocket.h
Bibliothèque	Websocket.lib
DLL	Websocket.dll

Voir aussi

WEB_SOCKET_PROPERTY

WebSocketAbortHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle