StreamWriter.Flush Method (System.IO)

.NET Framework Class Library

StreamWriter.Flush Method

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

Visual Basic (Declaration)

Public Overrides Sub Flush

Visual Basic (Usage)

Dim instance As StreamWriter

instance.Flush

public override void Flush ()

C++

public:
virtual void Flush () override

public void Flush ()

JScript

public override function Flush ()

Exceptions

Exception type	Condition
ObjectDisposedException	The current writer is closed.
IOException	An I/O error has occurred.

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.

The following table lists examples of other typical or related I/O tasks.

To do this...	See the example in this topic...
Create a text file.	How to: Write Text to a File
Write to a text file.	How to: Write Text to a File
Read from a text file.	How to: Read Text from a File
Append text to a file.	How to: Open and Append to a Log File File.AppendText FileInfo.AppendText
Get the size of a file.	FileInfo.Length
Get the attributes of a file.	File.GetAttributes
Set the attributes of a file.	File.SetAttributes
Determine if a file exists.	File.Exists
Read from a binary file.	How to: Read and Write to a Newly Created Data File
Write to a binary file.	How to: Read and Write to a Newly Created Data File

Platforms

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Version Information

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Reference

StreamWriter Class
StreamWriter Members
System.IO Namespace
Close

Other Resources

File and Stream I/O
How to: Read Text from a File
How to: Write Text to a File