This documentation is archived and is not being maintained.

Trace.Close Method

Flushes the output buffer, and then closes the Listeners.

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

<ConditionalAttribute("TRACE")> _
Public Shared Sub Close

Use this method when the output is going to a file, such as to the TextWriterTraceListener.

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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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