.NET Framework Class Library
TraceListener Class

Provides the abstract base class for the listeners who monitor trace and debug output.

Namespace:   System.Diagnostics
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/hy72797k_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/hy72797k_en-us_VS_110_2_0_0_0_1%].LinkDemand, Synchronization := True)> _
Public MustInherit Class TraceListener _
	Inherits [%$TOPIC/hy72797k_en-us_VS_110_2_0_0_0_2%] _
	Implements [%$TOPIC/hy72797k_en-us_VS_110_2_0_0_0_3%]
[[%$TOPIC/hy72797k_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/hy72797k_en-us_VS_110_2_0_1_0_1%].LinkDemand, Synchronization = true)]
public abstract class TraceListener : [%$TOPIC/hy72797k_en-us_VS_110_2_0_1_0_2%], 
	[%$TOPIC/hy72797k_en-us_VS_110_2_0_1_0_3%]
[[%$TOPIC/hy72797k_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/hy72797k_en-us_VS_110_2_0_2_0_1%]::LinkDemand, Synchronization = true)]
public ref class TraceListener abstract : public [%$TOPIC/hy72797k_en-us_VS_110_2_0_2_0_2%], 
	[%$TOPIC/hy72797k_en-us_VS_110_2_0_2_0_3%]
[<[%$TOPIC/hy72797k_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/hy72797k_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/hy72797k_en-us_VS_110_2_0_3_0_2%].LinkDemand, Synchronization = true)>]
type TraceListener =  
    class 
        inherit [%$TOPIC/hy72797k_en-us_VS_110_2_0_3_0_3%] 
        interface [%$TOPIC/hy72797k_en-us_VS_110_2_0_3_0_4%] 
    end

The TraceListener type exposes the following members.

Constructors
  NameDescription
Protected method Supported by the XNA Framework TraceListenerInitializes a new instance of the TraceListener class.
Protected method Supported by the XNA Framework TraceListener(String)Initializes a new instance of the TraceListener class using the specified name as the listener.
Top
Properties
  NameDescription
Public property AttributesGets the custom trace listener attributes defined in the application configuration file.
Public property FilterGets and sets the trace filter for the trace listener.
Public property Supported by the XNA Framework IndentLevelGets or sets the indent level.
Public property Supported by the XNA Framework IndentSizeGets or sets the number of spaces in an indent.
Public property IsThreadSafeGets a value indicating whether the trace listener is thread safe.
Public property Supported by the XNA Framework NameGets or sets a name for this TraceListener.
Protected property Supported by the XNA Framework NeedIndentGets or sets a value indicating whether to indent the output.
Public property TraceOutputOptionsGets or sets the trace output options.
Top
Methods
  NameDescription
Public method Supported by the XNA Framework CloseWhen overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output.
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.
Protected method Supported by the XNA Framework Dispose(Boolean)Releases the unmanaged resources used by the TraceListener and optionally releases the managed resources.
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.
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.
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 FlushWhen overridden in a derived class, flushes the output buffer.
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.
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.
Public method TraceData(TraceEventCache, String, TraceEventType, Int32, Object)Writes trace information, an array of data objects and event information to the listener specific output.
Public method TraceEvent(TraceEventCache, String, TraceEventType, Int32)Writes trace and event information to the listener specific output.
Public method TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)Writes trace information, a message, and event information to the listener specific output.
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.
Public method TraceTransferWrites trace information, a message, a related activity identity and event information to the listener specific output.
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.
Public method Supported by the XNA Framework Write(String)When overridden in a derived class, writes the specified message to the listener you create in the derived class.
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.
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.
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.
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.
Public method Supported by the XNA Framework WriteLine(String)When overridden in a derived class, writes a message to the listener you create in the derived class, followed by a line terminator.
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.
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.
Top
Remarks

For examples of how to implement a TraceListener, see the DefaultTraceListener, TextWriterTraceListener and the EventLogTraceListener classes.

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 similar to 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>

For more information on using configuration files for tracing, see <system.diagnostics> Element.

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.

Notes to Inheritors

Inherit from this class to implement a custom listener for the Debug and Trace classes. At a minimum, you must implement the Write and WriteLine methods. Additionally, you can implement the Fail, Close and Flush methods.

Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 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

This type is thread safe.