WsGetListenerProperty function (webservices.h)

Retrieves a specified Listener object property. The property to retrieve is identified by a WS_LISTENER_PROPERTY_ID input parameter.

Syntax

HRESULT WsGetListenerProperty(
  [in]           WS_LISTENER             *listener,
  [in]           WS_LISTENER_PROPERTY_ID id,
                 void                    *value,
  [in]           ULONG                   valueSize,
  [in, optional] WS_ERROR                *error
);

Parameters

[in] listener

A pointer to the Listener object containing the desired property. This must be a valid WS_LISTENER that was returned from WsCreateListener.

[in] id

This is a WS_LISTENER_PROPERTY_ID enumerator value that identifies the desired property.

value

A reference to a location for storing the retrieved property value. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

Represents the byte-length buffer size allocated by the caller to store the retrieved property value.

[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.

Requirements