TextWriterTraceListener Class
Directs tracing or debugging output to a TextWriter or to a Stream, such as FileStream.
Assembly: System (in System.dll)
The TextWriterTraceListener type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | TextWriterTraceListener() | Initializes a new instance of the TextWriterTraceListener class with TextWriter as the output recipient. |
![]() ![]() | TextWriterTraceListener(Stream) | Initializes a new instance of the TextWriterTraceListener class, using the stream as the recipient of the debugging and tracing output. |
![]() ![]() | TextWriterTraceListener(String) | Initializes a new instance of the TextWriterTraceListener class, using the file as the recipient of the debugging and tracing output. |
![]() ![]() | TextWriterTraceListener(TextWriter) | Initializes a new instance of the TextWriterTraceListener class using the specified writer as recipient of the tracing or debugging output. |
![]() ![]() | 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. |
![]() ![]() | 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. |
![]() ![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | Attributes | Gets the custom trace listener attributes defined in the application configuration file. (Inherited from TraceListener.) |
![]() | Filter | Gets and sets the trace filter for the trace listener. (Inherited from TraceListener.) |
![]() ![]() | IndentLevel | Gets or sets the indent level. (Inherited from TraceListener.) |
![]() ![]() | IndentSize | Gets or sets the number of spaces in an indent. (Inherited from TraceListener.) |
![]() | IsThreadSafe | Gets a value indicating whether the trace listener is thread safe. (Inherited from TraceListener.) |
![]() ![]() | Name | Gets or sets a name for this TraceListener. (Inherited from TraceListener.) |
![]() ![]() | NeedIndent | Gets or sets a value indicating whether to indent the output. (Inherited from TraceListener.) |
![]() | TraceOutputOptions | Gets or sets the trace output options. (Inherited from TraceListener.) |
![]() ![]() | Writer | Gets or sets the text writer that receives the tracing or debugging output. |
| Name | Description | |
|---|---|---|
![]() ![]() | Close | Closes the Writer so that it no longer receives tracing or debugging output. (Overrides TraceListener::Close().) |
![]() | 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.) |
![]() ![]() | Dispose() | Releases all resources used by the TraceListener. (Inherited from TraceListener.) |
![]() ![]() | Dispose(Boolean) | Infrastructure. Disposes this TextWriterTraceListener object. (Overrides TraceListener::Dispose(Boolean).) |
![]() ![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() ![]() | Fail(String) | Emits an error message to the listener you create when you implement the TraceListener class. (Inherited from TraceListener.) |
![]() ![]() | 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.) |
![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | Flush | Flushes the output buffer for the Writer. (Overrides TraceListener::Flush().) |
![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | GetSupportedAttributes | Gets the custom attributes supported by the trace listener. (Inherited from TraceListener.) |
![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() ![]() | MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
![]() ![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | TraceData(TraceEventCache, String, TraceEventType, Int32, Object) | Writes trace information, a data object and event information to the listener specific output. (Inherited from TraceListener.) |
![]() | TraceData(TraceEventCache, String, TraceEventType, Int32, array<Object>) | Writes trace information, an array of data objects and event information to the listener specific output. (Inherited from TraceListener.) |
![]() | TraceEvent(TraceEventCache, String, TraceEventType, Int32) | Writes trace and event information to the listener specific output. (Inherited from TraceListener.) |
![]() | TraceEvent(TraceEventCache, String, TraceEventType, Int32, String) | Writes trace information, a message, and event information to the listener specific output. (Inherited from TraceListener.) |
![]() | TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, array<Object>) | Writes trace information, a formatted array of objects and event information to the listener specific output. (Inherited from TraceListener.) |
![]() | TraceTransfer | Writes trace information, a message, a related activity identity and event information to the listener specific output. (Inherited from TraceListener.) |
![]() ![]() | 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.) |
![]() ![]() | Write(String) | Writes a message to this instance's Writer. (Overrides TraceListener::Write(String).) |
![]() ![]() | 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.) |
![]() ![]() | Write(String, String) | Writes a category name and a message to the listener you create when you implement the TraceListener class. (Inherited from TraceListener.) |
![]() ![]() | WriteIndent | Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false. (Inherited from TraceListener.) |
![]() ![]() | 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.) |
![]() ![]() | 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 TraceListener::WriteLine(String).) |
![]() ![]() | 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.) |
![]() ![]() | 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.) |
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>
Note |
|---|
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. |
Note |
|---|
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. |
| Topic | Location |
|---|---|
| Walkthrough: Integrating ASP.NET Tracing with System.Diagnostics Tracing | Building ASP .NET Web Applications |
| Walkthrough: Integrating ASP.NET Tracing with System.Diagnostics Tracing | Building ASP .NET Web Applications |
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 }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
