TraceListener
Class
Definition
Provides the abstract base class for the listeners who monitor trace and debug output.
public abstract class TraceListener : MarshalByRefObject, IDisposable
- Inheritance
- Derived
- Implements
Inherited Members
System.MarshalByRefObject
System.Object
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:DEBUGflag to the compiler command line when you compile your code, or you can add#define DEBUGto the top of your file. In Visual Basic, add the/d:DEBUG=Trueflag to the compiler command line.To enable tracing in C#, add the
/d:TRACEflag to the compiler command line when you compile your code, or add#define TRACEto the top of your file. In Visual Basic, add the/d:TRACE=Trueflag 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>.
Constructors
| TraceListener() |
Initializes a new instance of the TraceListener class. |
| TraceListener(String) |
Initializes a new instance of the TraceListener class using the specified name as the listener. |
Properties
| Attributes |
Gets the custom trace listener attributes defined in the application configuration file. |
| Filter |
Gets and sets the trace filter for the trace listener. |
| IndentLevel |
Gets or sets the indent level. |
| IndentSize |
Gets or sets the number of spaces in an indent. |
| IsThreadSafe |
Gets a value indicating whether the trace listener is thread safe. |
| Name |
Gets or sets a name for this TraceListener. |
| NeedIndent |
Gets or sets a value indicating whether to indent the output. |
| TraceOutputOptions |
Gets or sets the trace output options. |
Methods
| Close() |
When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output. |
| Dispose() |
Releases all resources used by the TraceListener. |
| Dispose(Boolean) |
Releases the unmanaged resources used by the TraceListener and optionally releases the managed resources. |
| Fail(String) |
Emits an error message to the listener you create when you implement the TraceListener class. |
| Fail(String, String) |
Emits an error message and a detailed error message to the listener you create when you implement the TraceListener class. |
| Flush() |
When overridden in a derived class, flushes the output buffer. |
| GetSupportedAttributes() |
Gets the custom attributes supported by the trace listener. |
| TraceData(TraceEventCache, String, TraceEventType, Int32, Object) |
Writes trace information, a data object and event information to the listener specific output. |
| TraceData(TraceEventCache, String, TraceEventType, Int32, Object[]) |
Writes trace information, an array of data objects and event information to the listener specific output. |
| TraceEvent(TraceEventCache, String, TraceEventType, Int32) |
Writes trace and event information to the listener specific output. |
| TraceEvent(TraceEventCache, String, TraceEventType, Int32, String) |
Writes trace information, a message, and event information to the listener specific output. |
| TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[]) |
Writes trace information, a formatted array of objects and event information to the listener specific output. |
| TraceTransfer(TraceEventCache, String, Int32, String, Guid) |
Writes trace information, a message, a related activity identity and event information to the listener specific output. |
| Write(Object) |
Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class. |
| Write(String) |
When overridden in a derived class, writes the specified message to the listener you create in the derived class. |
| 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. |
| Write(String, String) |
Writes a category name and a message to the listener you create when you implement the TraceListener class. |
| WriteIndent() |
Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to |
| 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. |
| 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. |
| 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. |
| 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. |
Thread Safety
This type is thread safe.