Export (0) Print
Expand All

Trace.Close Method

Flushes the output buffer, and then closes the Listeners.

[Visual Basic]
<Conditional("TRACE")>
Public Shared Sub Close()
[C#]
[Conditional("TRACE")]
public static void Close();
[C++]
[Conditional("TRACE")]
public: static void Close();
[JScript]
public
   Conditional("TRACE")
static function Close();

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.

Example

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.

[Visual Basic] 
Public Shared Sub Main()
    ' Create a file for output named TestFile.txt.
    Dim myFileName As String = "TestFile.txt"
    If Not File.Exists(myFileName) Then
        Dim myFile As Stream = File.Create(myFileName)
        
        ' Assign output file to output stream.
        Dim myOutputWriter As StreamWriter
        myOutputWriter = File.AppendText(myFileName)
        
        ' Create a new text writer using the output stream, and 
        ' add it to the trace listeners. 
        Dim myTextListener As New TextWriterTraceListener(myOutputWriter)
        Trace.Listeners.Add(myTextListener)
        
        ' Write output to the file.
        Trace.WriteLine("Test output")
        
        ' Flush and close the output stream.
        Trace.Flush()
        Trace.Close()
    End If
End Sub


[C#] 
public static void Main(string[] args) {
    // Create a file for output named TestFile.txt.
    String myFileName = "TestFile.txt";
    if(!File.Exists(myFileName))
    {
       Stream myFile = File.Create(myFileName);
 
    // Assign output file to output stream.
    StreamWriter myOutputWriter;
    myOutputWriter = File.AppendText(myFileName);
 
    /* Create a new text writer using the output stream, and 
     * add it to the trace listeners. */
    TextWriterTraceListener myTextListener = new 
       TextWriterTraceListener(myOutputWriter);
    Trace.Listeners.Add(myTextListener);
 
    // Write output to the file.
    Trace.WriteLine("Test output");
 
    // Flush and close the output stream.
    Trace.Flush();
    Trace.Close();
   }
 }
 

[C++] 
int main() {
   // Create a file for output named TestFile.txt.
   String* myFileName = S"TestFile.txt";
   if(!File::Exists(myFileName))
   {
      Stream* myFile = File::Create(myFileName);

      // Assign output file to output stream.
      StreamWriter* myOutputWriter;
      myOutputWriter = File::AppendText(myFileName);

      /* Create a new text writer using the output stream, and 
      * add it to the trace listeners. */
      TextWriterTraceListener* myTextListener = new 
         TextWriterTraceListener(myOutputWriter);
      Trace::Listeners->Add(myTextListener);

      // Write output to the file.
      Trace::WriteLine(S"Test output");

      // Flush and close the output stream.
      Trace::Flush();
      Trace::Close();
   }
}


[JScript] 
// Open or create a file stream for output named TestFile.txt.
var myOutputWriter : FileStream = File.OpenWrite("TestFile.txt")

// Specify myOutputWriter as the Trace output stream by
// adding it to the trace listeners. 
Trace.Listeners.Add(new TextWriterTraceListener(myOutputWriter))

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

// Flush and close the output stream.
Trace.Flush()
Trace.Close()

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Trace Class | Trace Members | System.Diagnostics Namespace | Debug | Trace | BooleanSwitch | TraceSwitch | TraceListener | DefaultTraceListener | ConditionalAttribute

Show:
© 2015 Microsoft