WsGetChannelProperty function

Retrieves a property of the Channel referenced by the channel parameter.

Syntax

HRESULT WINAPI  WsGetChannelProperty(
  _In_     WS_CHANNEL*            channel,
  _In_     WS_CHANNEL_PROPERTY_ID id,
           void*                  value,
  _In_     ULONG                  valueSize,
  _In_opt_ WS_ERROR*              error
);

Parameters

channel [in]

A pointer to the WS_CHANNEL object with the property to retrieve.

id [in]

Represents an identifier of the property to retrieve.

value

A void pointer referencing the location to store the retrieved property.

Note  The pointer must have an alignment compatible with the type of the property.

 

valueSize [in]

The number of bytes allocated by the caller to store the retrieved property.

error [in, optional]

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Requirements