WS_CREATE_LISTENER_CALLBACK callback function (webservices.h)

Handles the WsCreateListener call for a WS_CUSTOM_CHANNEL_BINDING.

Syntax

WS_CREATE_LISTENER_CALLBACK WsCreateListenerCallback;

HRESULT WsCreateListenerCallback(
  [in]           WS_CHANNEL_TYPE channelType,
                 const void *listenerParameters,
  [in]           ULONG listenerParametersSize,
                 void **listenerInstance,
  [in, optional] WS_ERROR *error
)
{...}

Parameters

[in] channelType

The type of channel the listener listens for.

listenerParameters

The pointer to the value that was specified by the WS_LISTENER_PROPERTY_CUSTOM_LISTENER_PARAMETERS property when the custom listener is created using WsCreateListener.

If the WS_LISTENER_PROPERTY_CUSTOM_LISTENER_PARAMETERS property was not specified, the value will be NULL.

[in] listenerParametersSize

The size in bytes of the value pointed to by listenerParameters.

If the WS_LISTENER_PROPERTY_CUSTOM_LISTENER_PARAMETERS property was not specified, the size will be 0.

listenerInstance

A pointer to an allocated structure that represents the listener instance. This pointer will be passed to all the other listener callbacks for this particular listener instance.

If this callback is successful, then the WS_FREE_LISTENER_CALLBACK will be used to free the listener instance.

[in, optional] error

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

Return value

Return code Description
WS_E_QUOTA_EXCEEDED
A quota was exceeded.
E_OUTOFMEMORY
Ran out of memory.
E_INVALIDARG
One or more arguments are invalid.
Other Errors
This function may return other errors not listed above.

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