StreamWriter.Flush Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Clears all buffers for the current writer and causes any buffered data to be written to the underlying stream.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Overrides Sub Flush
public override void Flush()

Exceptions

Exception Condition
ObjectDisposedException

The current writer is closed.

IOException

An I/O error has occurred.

EncoderFallbackException

The current encoding does not support displaying half of a Unicode surrogate pair.

Remarks

This method overrides Flush.

Flushing the stream will not flush its underlying encoder unless you explicitly call Flush or Close. Setting AutoFlush to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.