Edit

WS_GET_LISTENER_PROPERTY_CALLBACK callback function (webservices.h)

  • Article

Handles the WsGetListenerProperty call for a WS_CUSTOM_CHANNEL_BINDING.

Syntax

WS_GET_LISTENER_PROPERTY_CALLBACK WsGetListenerPropertyCallback;

HRESULT WsGetListenerPropertyCallback(
  [in]           void *listenerInstance,
  [in]           WS_LISTENER_PROPERTY_ID id,
                 void *value,
  [in]           ULONG valueSize,
  [in, optional] WS_ERROR *error
)
{...}

Parameters

[in] listenerInstance

The pointer to the state specific to this listener instance, as created by the WS_CREATE_LISTENER_CALLBACK.

[in] id

The id of the property to retrieve.

A custom listener can decide which properties to support.

value

The location to store the retrieved property. 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

Specifies where additional error information should be stored if the function fails.

Return value

Return code Description
E_INVALIDARG
 The property id was not supported for this object or the specified buffer was not large enough for the value.
Other Errors
This function may return other errors not listed above.

Remarks

See WsGetListenerProperty for information about the contract of this API.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header webservices.h