WS_ABANDON_MESSAGE_CALLBACK callback function (webservices.h)

Article
02/22/2024

Handles the WsAbandonMessage call for a WS_CUSTOM_CHANNEL_BINDING.

Syntax

WS_ABANDON_MESSAGE_CALLBACK WsAbandonMessageCallback;

HRESULT WsAbandonMessageCallback(
  [in]           void *channelInstance,
  [in]           WS_MESSAGE *message,
  [in, optional] WS_ERROR *error
)
{...}

Parameters

[in] channelInstance

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

[in] message

The message that is current being read or written. This should be the same message as was passed to WsWriteMessageStart or WsReadMessageStart.

[in, optional] error

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

Return value

Return code	Description
WS_E_INVALID_OPERATION	This is returned if the channel is not in the WS_CHANNEL_STATE_OPEN state or the WS_CHANNEL_STATE_FAULTED state.
E_INVALIDARG	The specified message is not currently being read or written using the channel.

Remarks

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