This documentation is archived and is not being maintained.

Trace.Flush Method

Flushes the output buffer, and causes buffered data to be written to the Listeners.

Namespace:  System.Diagnostics
Assembly:  System (in System.dll)

<ConditionalAttribute("TRACE")> _
Public Shared Sub 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 example creates a TextWriterTraceListener named myTextListener. myTextListener uses a StreamWriter called myOutputWriter to write to a file named TestFile.txt. The example creates the file, stream and text writer, writes one line of text to the file, and then flushes and closes the output.

' Specify /d:TRACE=True when compiling. 

Imports System
Imports System.IO
Imports System.Diagnostics

Class Test

    Shared Sub Main()

        ' Create a file for output named TestFile.txt. 
        Using myFileStream As New FileStream("TestFile.txt", FileMode.Append)

            ' Create a new text writer using the output stream 
            ' and add it to the trace listeners.  
            Dim myTextListener As New TextWriterTraceListener(myFileStream)

            ' Write output to the file.
            Trace.WriteLine("Test output")

            ' Flush and close the output stream.

        End Using 

    End Sub 'Main

End Class

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0, 2.0, 1.0