Trace.Close Trace.Close Trace.Close Trace.Close Method

Definition

Flushes the output buffer, and then closes the Listeners.

public:
 static void Close();
[System.Diagnostics.Conditional("TRACE")]
public static void Close ();
static member Close : unit -> unit
Public Shared Sub Close ()

Examples

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 /DTRACE when compiling.

#using <System.dll>
using namespace System;
using namespace System::IO;
using namespace System::Diagnostics;

void main()
{
     #if defined(TRACE)
    // Create a file for output named TestFile.txt.
    FileStream^ myFileStream = 
        gcnew FileStream( "TestFile.txt", FileMode::Append );
   
    // Create a new text writer using the output stream 
    // and add it to the trace listeners.
    TextWriterTraceListener^ myTextListener = 
        gcnew TextWriterTraceListener( myFileStream );
    Trace::Listeners->Add( myTextListener );
   
    // Write output to the file.
    Trace::WriteLine( "Test output" );
   
    // Flush and close the output stream.
    Trace::Flush();
    Trace::Close();
    #endif
}
// Specify /d:TRACE when compiling.

using System;
using System.IO;
using System.Diagnostics;

class Test
{
    static void Main()
    {
        // Create a file for output named TestFile.txt.
        using (FileStream myFileStream = 
            new FileStream("TestFile.txt", FileMode.Append))
        {
            // Create a new text writer using the output stream 
            // and add it to the trace listeners.
            TextWriterTraceListener myTextListener = 
                new TextWriterTraceListener(myFileStream);
            Trace.Listeners.Add(myTextListener);
          
            // Write output to the file.
            Trace.WriteLine("Test output");
         
            // Flush and close the output stream.
            Trace.Flush();
            Trace.Close();
        }
    }
}
' 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)
            Trace.Listeners.Add(myTextListener)
            
            ' Write output to the file.
            Trace.WriteLine("Test output")
            
            ' Flush and close the output stream.
            Trace.Flush()
            Trace.Close()
        
        End Using
        
    End Sub 'Main

End Class

Remarks

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.

Security

SecurityPermission
for operating with unmanaged code. Security action: Demand. Associated enumeration: UnmanagedCode

Applies to

See also