Windows Dev Center

WebSocketGetGlobalProperty function

The WebSocketGetGlobalProperty function gets a single WebSocket property.

Syntax


HRESULT WINAPI WebSocketGetGlobalProperty(
  _In_    WEB_SOCKET_PROPERTY eType,
  _Inout_ PVOID               pvValue,
  _Inout_ ULONG               *ulSize
);

Parameters

eType [in]

Type: WEB_SOCKET_PROPERTY

A WebSocket property.

pvValue [in, out]

Type: PVOID

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

ulSize [in, out]

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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Websocket.h

Library

Websocket.lib

DLL

Websocket.dll

See also

WEB_SOCKET_PROPERTY
WEB_SOCKET_PROPERTY_TYPE

 

 

Community Additions

ADD
Show:
© 2015 Microsoft