WebSocketCreateClientHandle-Funktion (websocket.h)

Die WebSocketCreateClientHandle-Funktion erstellt ein clientseitiges WebSocket-Sitzungshandle.

Syntax

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

Parameter

[in] pProperties

Typ: const PWEB_SOCKET_PROPERTY

Zeiger auf ein Array von WEB_SOCKET_PROPERTY Strukturen, die WebSocket-sitzungsbezogene Eigenschaften enthalten.

[in] ulPropertyCount

Typ: ULONG

Anzahl der Eigenschaften in pProperties.

[out] phWebSocket

Typ: WEB_SOCKET_HANDLE*

Zeigen Sie bei erfolgreicher Ausgabe auf ein neu zugewiesenes clientseitiges WebSocket-Sitzungshandle.

Rückgabewert

Typ: HRESULT

Wenn die Funktion erfolgreich ist, gibt sie S_OK zurück.

Wenn die Funktion fehlschlägt, gibt sie einen in WinError.h definierten Systemfehlercode zurück.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	websocket.h
Bibliothek	Websocket.lib
DLL	Websocket.dll

Weitere Informationen

WEB_SOCKET_PROPERTY

WebSocketAbortHandle

WebSocketCreateServerHandle

WebSocketDeleteHandle