TextWriterTraceListener Class
 

Directs tracing or debugging output to a TextWriter or to a Stream, such as FileStream.

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

Inheritance Hierarchy
SystemObject
   SystemMarshalByRefObject
     System.DiagnosticsTraceListener
      System.DiagnosticsTextWriterTraceListener
         System.DiagnosticsConsoleTraceListener
         System.DiagnosticsDelimitedListTraceListener
         System.DiagnosticsEventSchemaTraceListener
         System.DiagnosticsXmlWriterTraceListener

Syntax
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true)]
public class TextWriterTraceListener : TraceListener
[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true)]
public ref class TextWriterTraceListener : TraceListener
[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true)>]
type TextWriterTraceListener = 
    class
        inherit TraceListener
    end
<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization := True)>
Public Class TextWriterTraceListener
	Inherits TraceListener
Constructors
NameDescription
System_CAPS_pubmethod TextWriterTraceListener

Initializes a new instance of the TextWriterTraceListener class with TextWriter as the output recipient.

System_CAPS_pubmethod TextWriterTraceListener

Initializes a new instance of the TextWriterTraceListener class, using the stream as the recipient of the debugging and tracing output.

System_CAPS_pubmethod TextWriterTraceListener

Initializes a new instance of the TextWriterTraceListener class with the specified name, using the stream as the recipient of the debugging and tracing output.

System_CAPS_pubmethod TextWriterTraceListener

Initializes a new instance of the TextWriterTraceListener class, using the file as the recipient of the debugging and tracing output.

System_CAPS_pubmethod TextWriterTraceListener

Initializes a new instance of the TextWriterTraceListener class with the specified name, using the file as the recipient of the debugging and tracing output.

System_CAPS_pubmethod TextWriterTraceListener

Initializes a new instance of the TextWriterTraceListener class using the specified writer as recipient of the tracing or debugging output.

System_CAPS_pubmethod TextWriterTraceListener

Initializes a new instance of the TextWriterTraceListener class with the specified name, using the specified writer as recipient of the tracing or debugging output.

Properties
NameDescription
System_CAPS_pubproperty

Gets the custom trace listener attributes defined in the application configuration file.(Inherited from TraceListener.)

System_CAPS_pubproperty

Gets and sets the trace filter for the trace listener.(Inherited from TraceListener.)

System_CAPS_pubproperty

Gets or sets the indent level.(Inherited from TraceListener.)

System_CAPS_pubproperty

Gets or sets the number of spaces in an indent.(Inherited from TraceListener.)

System_CAPS_pubproperty

Gets a value indicating whether the trace listener is thread safe. (Inherited from TraceListener.)

System_CAPS_pubproperty

Gets or sets a name for this TraceListener.(Inherited from TraceListener.)

System_CAPS_protproperty

Gets or sets a value indicating whether to indent the output.(Inherited from TraceListener.)

System_CAPS_pubproperty

Gets or sets the trace output options.(Inherited from TraceListener.)

System_CAPS_pubproperty

Gets or sets the text writer that receives the tracing or debugging output.

Methods
NameDescription
System_CAPS_pubmethod Close

Closes the so that it no longer receives tracing or debugging output.(Overrides TraceListenerClose.)

System_CAPS_pubmethod CreateObjRef

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Dispose

Releases all resources used by the TraceListener.(Inherited from TraceListener.)

System_CAPS_protmethod Dispose

This API supports the product infrastructure and is not intended to be used directly from your code. Disposes this TextWriterTraceListener object.(Overrides TraceListenerDispose.)

System_CAPS_pubmethod Equals

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethod Fail

Emits an error message to the listener you create when you implement the TraceListener class.(Inherited from TraceListener.)

System_CAPS_pubmethod Fail

Emits an error message and a detailed error message to the listener you create when you implement the TraceListener class.(Inherited from TraceListener.)

System_CAPS_protmethod Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethod Flush

Flushes the output buffer for the .(Overrides TraceListenerFlush.)

System_CAPS_pubmethod GetHashCode

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethod GetSupportedAttributes

Gets the custom attributes supported by the trace listener.(Inherited from TraceListener.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethod TraceData

Writes trace information, a data object and event information to the listener specific output.(Inherited from TraceListener.)

System_CAPS_pubmethod TraceData

Writes trace information, an array of data objects and event information to the listener specific output.(Inherited from TraceListener.)

System_CAPS_pubmethod TraceEvent

Writes trace and event information to the listener specific output.(Inherited from TraceListener.)

System_CAPS_pubmethod TraceEvent

Writes trace information, a message, and event information to the listener specific output.(Inherited from TraceListener.)

System_CAPS_pubmethod TraceEvent

Writes trace information, a formatted array of objects and event information to the listener specific output.(Inherited from TraceListener.)

System_CAPS_pubmethod TraceTransfer

Writes trace information, a message, a related activity identity and event information to the listener specific output.(Inherited from TraceListener.)

System_CAPS_pubmethod Write

Writes the value of the object's ToString method to the listener you create when you implement the TraceListener class.(Inherited from TraceListener.)

System_CAPS_pubmethod Write

Writes a category name and the value of the object's ToString method to the listener you create when you implement the TraceListener class.(Inherited from TraceListener.)

System_CAPS_pubmethod Write

Writes a message to this instance's .(Overrides TraceListenerWrite.)

System_CAPS_pubmethod Write

Writes a category name and a message to the listener you create when you implement the TraceListener class.(Inherited from TraceListener.)

System_CAPS_protmethod WriteIndent

Writes the indent to the listener you create when you implement this class, and resets the property to false.(Inherited from TraceListener.)

System_CAPS_pubmethod WriteLine

Writes the value of the object's ToString method to the listener you create when you implement the TraceListener class, followed by a line terminator.(Inherited from TraceListener.)

System_CAPS_pubmethod WriteLine

Writes a category name and the value of the object's ToString method to the listener you create when you implement the TraceListener class, followed by a line terminator.(Inherited from TraceListener.)

System_CAPS_pubmethod WriteLine

Writes a message to this instance's followed by a line terminator. The default line terminator is a carriage return followed by a line feed (\r\n).(Overrides TraceListenerWriteLine.)

System_CAPS_pubmethod WriteLine

Writes a category name and a message to the listener you create when you implement the TraceListener class, followed by a line terminator.(Inherited from TraceListener.)

Remarks

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

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

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

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>
System_CAPS_noteNote

If an attempt is made to write to a file that is in use or unavailable, the file name is automatically prefixed by a GUID.

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 . 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.

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
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
}
Version Information
Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top