Edit

WS_OPEN_LISTENER_CALLBACK callback function (webservices.h)

  • Article

Handles the WsOpenListener call for a WS_CUSTOM_CHANNEL_BINDING.

Syntax

WS_OPEN_LISTENER_CALLBACK WsOpenListenerCallback;

HRESULT WsOpenListenerCallback(
  [in]           void *listenerInstance,
  [in]           const WS_STRING *url,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [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] url

The URL to listen on. The format and interpretation of the URL is defined by the custom listener.

[in, optional] asyncContext

Information on how to invoke the function asynchronously, or NULL if invoking synchronously.

[in, optional] error

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

Return value

Return code Description
WS_S_ASYNC
 The asynchronous operation is still pending.
WS_E_OPERATION_ABORTED
 The listener was aborted during the open, or before the open.
WS_E_INVALID_OPERATION
 The listener is in the incorrect state.
WS_E_ADDRESS_IN_USE
 The address is already being used.
WS_E_ADDRESS_NOT_AVAILABLE
 The address is not valid for this context.
WS_E_QUOTA_EXCEEDED
 A quota was exceeded.
WS_E_OPERATION_ABORTED
 The operation was aborted.
WS_E_OPERATION_TIMED_OUT
 The operation did not complete within the time allotted.
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.

Remarks

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