Edit

Share via

WsGetChannelProperty function (webservices.h)

  • Article

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

Syntax

HRESULT WsGetChannelProperty(
  [in]           WS_CHANNEL             *channel,
  [in]           WS_CHANNEL_PROPERTY_ID id,
                 void                   *value,
  [in]           ULONG                  valueSize,
  [in, optional] WS_ERROR               *error
);

Parameters

[in] channel

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

[in] id

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.

 

[in] valueSize

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

[in, optional] error

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.

Return code Description
E_INVALIDARG
 The property Id was not supported for this object or the specified buffer was not large enough.
E_OUTOFMEMORY
 Ran out of memory.
Other Errors
This function may return other errors not listed above.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header webservices.h
Library WebServices.lib
DLL WebServices.dll