WebSocketGetGlobalProperty-Funktion (websocket.h)

Die WebSocketGetGlobalProperty-Funktion ruft eine einzelne WebSocket-Eigenschaft ab.

Syntax

HRESULT WebSocketGetGlobalProperty(
  [in]      WEB_SOCKET_PROPERTY_TYPE eType,
  [in, out] PVOID                    pvValue,
  [in, out] ULONG                    *ulSize
);

Parameter

[in] eType

Typ: WEB_SOCKET_PROPERTY

Eine WebSocket-Eigenschaft.

[in, out] pvValue

Typ: PVOID

Ein Zeiger auf den Eigenschaftswert. Der Zeiger muss über eine Ausrichtung verfügen, die mit dem Typ der Eigenschaft kompatibel ist.

[in, out] ulSize

Typ: ULONG*

Die Größe der Eigenschaft in Bytes, auf die von pvValue verwiesen wird.

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

WEB_SOCKET_PROPERTY_TYPE