TextWriterTraceListener TextWriterTraceListener TextWriterTraceListener TextWriterTraceListener Class

Definition

public ref class TextWriterTraceListener : System::Diagnostics::TraceListener

public class TextWriterTraceListener : System.Diagnostics.TraceListener

type TextWriterTraceListener = class
    inherit TraceListener

Public Class TextWriterTraceListener
Inherits TraceListener

Inheritance

ObjectObjectObjectObject

MarshalByRefObjectMarshalByRefObjectMarshalByRefObjectMarshalByRefObject

TraceListenerTraceListenerTraceListenerTraceListener

TextWriterTraceListenerTextWriterTraceListenerTextWriterTraceListenerTextWriterTraceListener

Derived

System.Diagnostics.ConsoleTraceListenerSystem.Diagnostics.ConsoleTraceListenerSystem.Diagnostics.ConsoleTraceListenerSystem.Diagnostics.ConsoleTraceListener

System.Diagnostics.DelimitedListTraceListenerSystem.Diagnostics.DelimitedListTraceListenerSystem.Diagnostics.DelimitedListTraceListenerSystem.Diagnostics.DelimitedListTraceListener

System.Diagnostics.EventSchemaTraceListenerSystem.Diagnostics.EventSchemaTraceListenerSystem.Diagnostics.EventSchemaTraceListenerSystem.Diagnostics.EventSchemaTraceListener

System.Diagnostics.XmlWriterTraceListenerSystem.Diagnostics.XmlWriterTraceListenerSystem.Diagnostics.XmlWriterTraceListenerSystem.Diagnostics.XmlWriterTraceListener

Examples

The following example implements an instance of the TextWriterTraceListener class that uses a StreamWriter called myOutputWriter to write to a file named TestFile.txt. First the example creates a file for output. Then it creates the StreamWriter for the first text writer, assigns it the output file, and adds it to the Listeners. Then, the code outputs one line of text to the file. Finally, the example flushes the output buffer.

After running this sample, you can open the TestFile.txt file to see the output.

void main()
{
   #if defined(TRACE)
   // Create a file for output named TestFile.txt.
   Stream^ myFile = File::Create( "TestFile.txt" );
   
   // Create a new text writer using the output stream and
   // add it to the trace listeners.
   TextWriterTraceListener^ myTextListener = 
      gcnew TextWriterTraceListener( myFile );
   Trace::Listeners->Add( myTextListener );
  
   // Write output to the file.
   Trace::Write( "Test output " );
  
   // Flush the output.
   Trace::Flush();
   Trace::Close();
   #endif
}

public class Sample
{

public static int Main(string[] args) {
    // Create a file for output named TestFile.txt.
    Stream myFile = File.Create("TestFile.txt");
 
    /* Create a new text writer using the output stream, and add it to
     * the trace listeners. */
    TextWriterTraceListener myTextListener = new 
       TextWriterTraceListener(myFile);
    Trace.Listeners.Add(myTextListener);
 
    // Write output to the file.
    Trace.Write("Test output ");
 

    // Flush the output.
    Trace.Flush(); 

    return 0;
 }

}

Public Class Sample
    
    Public Shared Sub Main()
        ' Create a file for output named TestFile.txt.
        Dim myFile As Stream = File.Create("TestFile.txt")
        
        ' Create a new text writer using the output stream, and add it to
        ' the trace listeners. 
        Dim myTextListener As New TextWriterTraceListener(myFile)
        Trace.Listeners.Add(myTextListener)

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

        System.Environment.ExitCode = 0
    End Sub

End Class

Remarks

The TextWriterTraceListener class provides the Writer property to get or set the text writer that receives the tracing or debugging output.

This class also provides methods to Close the Writer so that it no longer receives tracing or debugging output, to Flush the output buffer for the Writer, and to Write a message to the Writer.

You must enable tracing or debugging to use a trace listener. The following syntax is compiler specific. If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

• To enable debugging in C#, add the /d:DEBUG flag to the compiler command line when you compile your code, or you can add #define DEBUG to the top of your file. In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

• To enable tracing in C#, add the /d:TRACE flag to the compiler command line when you compile your code, or add #define TRACE to the top of your file. In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

To add a trace listener, edit the configuration file that corresponds to the name of your application. Within this file, you can add a listener, set its type and set its parameter, remove a listener, or clear all the listeners previously set by the application. The configuration file should be formatted like the following example.

<configuration>  
  <system.diagnostics>  
    <trace autoflush="false" indentsize="4">  
      <listeners>  
        <add name="myListener"   
          type="System.Diagnostics.TextWriterTraceListener"   
          initializeData="TextWriterOutput.log" />  
        <remove name="Default" />  
      </listeners>  
    </trace>  
  </system.diagnostics>  
</configuration>  

Constructors

Properties

Methods

Applies to

See also

• TraceListener TraceListener TraceListener TraceListener
• DefaultTraceListener
• ConsoleTraceListener
• EventLogTraceListener
• Stream Stream Stream Stream
• TextWriter TextWriter TextWriter TextWriter
• Debug
• Trace