Share via

flush Method (Compact 2013)

  • Article

3/26/2014

This method flushes the object's internal buffer to its destination IStream/String. Flushing occurs when one of the following three actions occur:

  • There is access to the output property.
  • The endDocument event is called.
  • The flush method is called.

Syntax

HRESULT flush( );

Parameters

None.

Return Value

  • S_OK
    Returned if no errors are reported.

Remarks

Avoid handling the underlying IStream object during output (for example, direct writing). Keep in mind that a correspondence between Simple API for XML (SAX2) events and output text is not generally specified, though an implementation can provide it. Therefore, when using the flush method, the exact position within the generated document is not generally known. If the flush method interrupts the IMXWriter output, all output that has been processed is put into the underlying IStream/ISequentialStream object.

Requirements

Header

msxml2.h,
msxml2.idl

Library

uuid.lib

See Also

Reference

IMXWriter
output Property (XML SAX)