.NET Framework Class Library
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)
Syntax
<[%$TOPIC/d1ckdta4_en-us_VS_110_5_0_0_0_0%]([%$TOPIC/d1ckdta4_en-us_VS_110_5_0_0_0_1%].LinkDemand, Synchronization := True)> _
Public Class TextWriterTraceListener _
	Inherits [%$TOPIC/d1ckdta4_en-us_VS_110_5_0_0_0_2%]
[[%$TOPIC/d1ckdta4_en-us_VS_110_5_0_1_0_0%]([%$TOPIC/d1ckdta4_en-us_VS_110_5_0_1_0_1%].LinkDemand, Synchronization = true)]
public class TextWriterTraceListener : [%$TOPIC/d1ckdta4_en-us_VS_110_5_0_1_0_2%]
[[%$TOPIC/d1ckdta4_en-us_VS_110_5_0_2_0_0%]([%$TOPIC/d1ckdta4_en-us_VS_110_5_0_2_0_1%]::LinkDemand, Synchronization = true)]
public ref class TextWriterTraceListener : public [%$TOPIC/d1ckdta4_en-us_VS_110_5_0_2_0_2%]
[<[%$TOPIC/d1ckdta4_en-us_VS_110_5_0_3_0_0%]([%$TOPIC/d1ckdta4_en-us_VS_110_5_0_3_0_1%].LinkDemand, Synchronization = true)>]
type TextWriterTraceListener =  
    class 
        inherit [%$TOPIC/d1ckdta4_en-us_VS_110_5_0_3_0_2%] 
    end

The TextWriterTraceListener type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework TextWriterTraceListenerInitializes a new instance of the TextWriterTraceListener class with TextWriter as the output recipient.
Public method Supported by the XNA Framework TextWriterTraceListener(Stream)Initializes a new instance of the TextWriterTraceListener class, using the stream as the recipient of the debugging and tracing output.
Public method Supported by the XNA Framework TextWriterTraceListener(String)Initializes a new instance of the TextWriterTraceListener class, using the file as the recipient of the debugging and tracing output.
Public method Supported by the XNA Framework TextWriterTraceListener(TextWriter)Initializes a new instance of the TextWriterTraceListener class using the specified writer as recipient of the tracing or debugging output.
Public method Supported by the XNA Framework TextWriterTraceListener(Stream, String)Initializes a new instance of the TextWriterTraceListener class with the specified name, using the stream as the recipient of the debugging and tracing output.
Public method Supported by the XNA Framework TextWriterTraceListener(String, String)Initializes a new instance of the TextWriterTraceListener class with the specified name, using the file as the recipient of the debugging and tracing output.
Public method Supported by the XNA Framework TextWriterTraceListener(TextWriter, String)Initializes a new instance of the TextWriterTraceListener class with the specified name, using the specified writer as recipient of the tracing or debugging output.
Top
Properties
  NameDescription
Public property AttributesGets the custom trace listener attributes defined in the application configuration file. (Inherited from TraceListener.)
Public property FilterGets and sets the trace filter for the trace listener. (Inherited from TraceListener.)
Public property Supported by the XNA Framework IndentLevelGets or sets the indent level. (Inherited from TraceListener.)
Public property Supported by the XNA Framework IndentSizeGets or sets the number of spaces in an indent. (Inherited from TraceListener.)
Public property IsThreadSafeGets a value indicating whether the trace listener is thread safe. (Inherited from TraceListener.)
Public property Supported by the XNA Framework NameGets or sets a name for this TraceListener. (Inherited from TraceListener.)
Protected property Supported by the XNA Framework NeedIndentGets or sets a value indicating whether to indent the output. (Inherited from TraceListener.)
Public property TraceOutputOptionsGets or sets the trace output options. (Inherited from TraceListener.)
Public property Supported by the XNA Framework WriterGets or sets the text writer that receives the tracing or debugging output.
Top
Methods
  NameDescription
Public method Supported by the XNA Framework CloseCloses the Writer so that it no longer receives tracing or debugging output. (Overrides TraceListenerClose.)
Public method CreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework DisposeReleases all resources used by the TraceListener. (Inherited from TraceListener.)
Protected method Supported by the XNA Framework Dispose(Boolean)Infrastructure. Disposes this TextWriterTraceListener object. (Overrides TraceListenerDispose(Boolean).)
Public method Supported by the XNA Framework Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Supported by the XNA Framework Fail(String)Emits an error message to the listener you create when you implement the TraceListener class. (Inherited from TraceListener.)
Public method Supported by the XNA Framework Fail(String, String)Emits an error message and a detailed error message to the listener you create when you implement the TraceListener class. (Inherited from TraceListener.)
Protected method Supported by the XNA Framework FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework FlushFlushes the output buffer for the Writer. (Overrides TraceListenerFlush.)
Public method Supported by the XNA Framework GetHashCodeServes as the default hash function. (Inherited from Object.)
Public method GetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetSupportedAttributesGets the custom attributes supported by the trace listener. (Inherited from TraceListener.)
Public method Supported by the XNA Framework GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method Supported by the XNA Framework MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method Supported by the XNA Framework ToStringReturns a string that represents the current object. (Inherited from Object.)
Public method TraceData(TraceEventCache, String, TraceEventType, Int32, Object)Writes trace information, a data object and event information to the listener specific output. (Inherited from TraceListener.)
Public method TraceData(TraceEventCache, String, TraceEventType, Int32, Object)Writes trace information, an array of data objects and event information to the listener specific output. (Inherited from TraceListener.)
Public method TraceEvent(TraceEventCache, String, TraceEventType, Int32)Writes trace and event information to the listener specific output. (Inherited from TraceListener.)
Public method TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)Writes trace information, a message, and event information to the listener specific output. (Inherited from TraceListener.)
Public method TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object)Writes trace information, a formatted array of objects and event information to the listener specific output. (Inherited from TraceListener.)
Public method TraceTransferWrites trace information, a message, a related activity identity and event information to the listener specific output. (Inherited from TraceListener.)
Public method Supported by the XNA Framework Write(Object)Writes the value of the object's ToString method to the listener you create when you implement the TraceListener class. (Inherited from TraceListener.)
Public method Supported by the XNA Framework Write(String)Writes a message to this instance's Writer. (Overrides TraceListenerWrite(String).)
Public method Supported by the XNA Framework Write(Object, String)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.)
Public method Supported by the XNA Framework Write(String, String)Writes a category name and a message to the listener you create when you implement the TraceListener class. (Inherited from TraceListener.)
Protected method Supported by the XNA Framework WriteIndentWrites the indent to the listener you create when you implement this class, and resets the NeedIndent property to false. (Inherited from TraceListener.)
Public method Supported by the XNA Framework WriteLine(Object)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.)
Public method Supported by the XNA Framework WriteLine(String)Writes a message to this instance's Writer followed by a line terminator. The default line terminator is a carriage return followed by a line feed (\r\n). (Overrides TraceListenerWriteLine(String).)
Public method Supported by the XNA Framework WriteLine(Object, String)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.)
Public method Supported by the XNA Framework WriteLine(String, String)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.)
Top
Remarks

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

Important noteImportant

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

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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.

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
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;
 }

}
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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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.