WsFlushBody function (webservices.h)

Article
02/22/2024

Flushes all accumulated message body data that has been written.

When message uses WsWriteBody or XML Writer, the data is accumulated in a buffer. WsFlushBody subsequently performs the actual I/O.

WsFlushBody is typically used when channel I/O is set to WS_STREAMED_OUTPUT_TRANSFER_MODE, or when using an XML Writer set to use WS_XML_WRITER_STREAM_OUTPUT.

Syntax

HRESULT WsFlushBody(
  [in]           WS_MESSAGE             *message,
  [in]           ULONG                  minSize,
  [in, optional] const WS_ASYNC_CONTEXT *asyncContext,
  [in, optional] WS_ERROR               *error
);

Parameters

[in] message

A pointer to the WS_MESSAGE structure containing the accumulated message body data.

[in] minSize

Specifies the minimum number of bytes that must be present in the message for the function to perform the data flush.

Note If the message contains less than minSize WSFlushBody terminates without doing the I/O flush. A larger value will ensure that no I/O will be done until the larger value has been accumulated. This is useful for ensuring that larger chunks are used when doing I/O. And presuming that there is at least one byte of accumulated data a value of 0 in minSize guarantees that it will be flushed.

[in, optional] asyncContext

A pointer to a WS_ASYNC_CONTEXT data structure with information about invoking the function asynchronously. A NULL value indicates a request for synchronous operation.

[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_S_ASYNC	The asynchronous operation is still pending.
WS_E_INVALID_FORMAT	The input data was not in the expected format or did not have the expected value.
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

This function is a "no-op" when WS_STREAMED_OUTPUT_TRANSFER_MODE is not set, or when using an XML Writer with WS_XML_WRITER_BUFFER_OUTPUT set.

This function is shortcut for calling WsFlushWriter for the XML Writer being used to write the message. Calling WsFlushWriter directly is equivalent to calling this function.

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

Share via