WS_CLOSE_CHANNEL_CALLBACK callback function (webservices.h)

Article
02/22/2024

Handles the WsCloseChannel call for a WS_CUSTOM_CHANNEL_BINDING.

Syntax

WS_CLOSE_CHANNEL_CALLBACK WsCloseChannelCallback;

HRESULT WsCloseChannelCallback(
  [in]           void *channelInstance,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR *error
)
{...}

Parameters

[in] channelInstance

The pointer to the state specific to this channel instance, as created by the WS_CREATE_CHANNEL_CALLBACK.

[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 close was aborted by a call to WsAbortChannel as it was closing.
WS_E_INVALID_OPERATION	The channel was in an inappropriate state.
WS_E_OPERATION_ABORTED	The operation was aborted.
WS_E_INVALID_OPERATION	The operation is not allowed due to the current state of the object.
WS_E_ENDPOINT_DISCONNECTED	The connection with the remote endpoint was terminated.
WS_E_ENDPOINT_FAILURE	The remote endpoint could not process the request.
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
WS_E_OPERATION_TIMED_OUT	The operation did not complete within the time allotted.
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.

Remarks

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