Edit

WebSocketGetGlobalProperty function (websocket.h)

  • Article

The WebSocketGetGlobalProperty function gets a single WebSocket property.

Syntax

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

Parameters

[in] eType

Type: WEB_SOCKET_PROPERTY

A WebSocket property.

[in, out] pvValue

Type: PVOID

A pointer to the property value. The pointer must have an alignment compatible with the type of the property.

[in, out] ulSize

Type: ULONG*

The size, in bytes, of the property pointed to by pvValue.

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

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header websocket.h
Library Websocket.lib
DLL Websocket.dll

See also

WEB_SOCKET_PROPERTY

WEB_SOCKET_PROPERTY_TYPE