flush Method

Flushes the object's internal buffer to its destination IStream/string. This flushing occurs when one of the following conditions is met:

The output property is set to a destination.
The endDocument() event is called.
The flush() method is called.

[Visual Basic]

Implementation Syntax

Sub flush()

Usage Syntax

oMXXMLWriter.flush

[C/C++]

Syntax

HRESULT flush ( );

Return Values

S_OK: The value returned if no errors are reported.

Remarks

The flush method has no effect for DOMDocument output. 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, although 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 writer output, all output that has been processed is put into the underlying IStream/ISequentialStream object.

The flush method is not implemented by XSLProcessor objects.

To view reference information for Visual Basic or C/C++ only, click the Language Filter button in the upper-left corner of the page.