WS_CREATE_CHANNEL_FOR_LISTENER_CALLBACK callback function (webservices.h)

Article
10/13/2021

Handles the WsCreateChannelForListener call for a WS_CUSTOM_CHANNEL_BINDING.

Syntax

WS_CREATE_CHANNEL_FOR_LISTENER_CALLBACK WsCreateChannelForListenerCallback;

HRESULT WsCreateChannelForListenerCallback(
  [in]           void *listenerInstance,
                 const void *channelParameters,
  [in]           ULONG channelParametersSize,
                 void **channelInstance,
  [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.

channelParameters

The pointer to the value that was specified by the WS_CHANNEL_PROPERTY_CUSTOM_CHANNEL_PARAMETERS property when the custom channel is created using WsCreateChannelForListener.

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

[in] channelParametersSize

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

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

channelInstance

A pointer to a structure allocated by the callback that contains the data specific to this channel instance. This pointer will be passed to all the other channel callbacks for this particular channel instance.

If this callback is successful, then the WS_FREE_CHANNEL_CALLBACK will be used to free the channel instance returned in this parameter.

[in, optional] error

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

Return value

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

Remarks

See WsCreateChannelForListener 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

Share via