System.IO.FileStream.Flush Method

Clears buffers for this stream and causes any buffered data to be written to the file.

Syntax

public override void Flush ()

Exceptions

TypeReason
System.IO.IOExceptionAn I/O error occurred.
ObjectDisposedExceptionThe current instance has already been closed.

Remarks

This method overrides Stream.Flush.

When you call the FileStream.Flush method, the operating system I/O buffer is also flushed.

A stream’s encoder is not flushed unless you explicitly call FileStream.Flush or dispose of the object. Setting StreamWriter.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.

Because a buffer can be used for either reading or writing, FileStream.Flush performs the following two functions:

  • Any data previously written to the buffer is copied to the file and the buffer is cleared except for its encoder state.

  • If BufferedStream.CanSeek is true and data was previously copied from the file to the buffer for reading, the current position within the file is decremented by the number of unread bytes in the buffer. The buffer is then cleared.

Use the FileStream.Flush(bool) method overload when you want to ensure that all buffered data in intermediate file buffers is written to disk.

Requirements

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0