WsWriteEnvelopeEnd function (webservices.h)

  • Article

Writes the closing elements of a message. This function writes the end of the message including the element that closes the body tag and the envelope tag. Use this function when writing messages to destinations other than channels. With channels use WsWriteMessageEnd

Syntax

HRESULT WsWriteEnvelopeEnd(
  [in]           WS_MESSAGE *message,
  [in, optional] WS_ERROR   *error
);

Parameters

[in] message

A pointer to the Message object to write. The pointer must reference a valid WS_MESSAGE object.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

This function can return one of these values.

Return code Description
WS_E_INVALID_FORMAT
 The input data was not in the expected format or did not have the expected value.
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

To use this function the message state must be set to WS_MESSAGE_STATE_WRITING. If called in the correct state the message will transition to WS_MESSAGE_STATE_DONE regardless of whether the function fails or not.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header webservices.h
Library WebServices.lib
DLL WebServices.dll