Debug.Flush Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Flushes the output buffer and causes buffered data to write to the Listeners collection.

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

<ConditionalAttribute("DEBUG")>
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 FileStream called myFileStream to write to a file named TestFile.txt. The example creates the stream, opens the file if it exists or creates a new one, writes one line of text to the file, and then flushes and closes the output.

' Specify /d:DEBUG=True when compiling.

Imports System
Imports System.IO
Imports System.Diagnostics

Class Test

    Shared Sub Main()

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

            ' Add the stream object to the trace listeners. 
            Dim myTextListener As New TextWriterTraceListener(myFileStream)
            Debug.Listeners.Add(myTextListener)

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

            ' Flush and close the output stream.
            Debug.Flush()
            Debug.Close()

        End Using

    End Sub 'Main

End Class

.NET Framework
Available since 1.1
Return to top
Show: