DelimitedListTraceListener Class

Definition

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.TextWriterTraceListener.dll

Source:

DelimitedListTraceListener.cs

Directs tracing or debugging output to a text writer, such as a stream writer, or to a stream, such as a file stream.

public ref class DelimitedListTraceListener : System::Diagnostics::TextWriterTraceListener

public class DelimitedListTraceListener : System.Diagnostics.TextWriterTraceListener

type DelimitedListTraceListener = class
    inherit TextWriterTraceListener

Public Class DelimitedListTraceListener
Inherits TextWriterTraceListener

Inheritance

Object

MarshalByRefObject

TraceListener

TextWriterTraceListener

DelimitedListTraceListener

Remarks

The trace output is in a delimited text format that uses the delimiter specified by the Delimiter property. The delimiter is used to terminate each field in a line of output. For example, to display the trace output in a Microsoft Excel spreadsheet, you might specify a comma (",") as a delimiter and create a comma-separated value (CSV) file.

Important

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

You can create a DelimitedListTraceListener in your code. Alternatively, in .NET Framework apps only, you can enable or disable a DelimitedListTraceListener through the application configuration file and then use the configured DelimitedListTraceListener in your application.

Note

The DelimitedListTraceListener delimits only text that is emitted by using the methods that have names starting with the word Trace, such as DelimitedListTraceListener.TraceEvent or Trace.TraceWarning. Trace data that is emitted by using the Debug.Write and TextWriterTraceListener.WriteLine methods is not delimited.

To configure a DelimitedListTraceListener in a .NET Framework app, edit the configuration file that corresponds to the name of your application. In this file, you can add a listener, set the properties for a listener, or remove a listener. The configuration file should be formatted as shown in the following example:

<configuration>  
  <system.diagnostics>  
    <trace autoflush="false" indentsize="4">  
      <listeners>  
        <add name="delimitedListener"   
          type="System.Diagnostics.DelimitedListTraceListener"   
          delimiter=","   
          initializeData="delimitedOutput.csv"   
          traceOutputOptions="ProcessId, DateTime" />  
      </listeners>  
    </trace>  
  </system.diagnostics>  
</configuration>  

Note

If you try to write to a file that is in use or unavailable, the file name is automatically prefixed by a GUID.

Note

Listeners are intended to be used by methods of the Debug, Trace, and TraceSource classes to write trace information. Listener methods, except for constructors, should not be called directly from application code.

Constructors

DelimitedListTraceListener(Stream)	Initializes a new instance of the DelimitedListTraceListener class that writes to the specified output stream.
DelimitedListTraceListener(Stream, String)	Initializes a new instance of the DelimitedListTraceListener class that writes to the specified output stream and has the specified name.
DelimitedListTraceListener(String)	Initializes a new instance of the DelimitedListTraceListener class that writes to the specified file.
DelimitedListTraceListener(String, String)	Initializes a new instance of the DelimitedListTraceListener class that writes to the specified file and has the specified name.
DelimitedListTraceListener(TextWriter)	Initializes a new instance of the DelimitedListTraceListener class that writes to the specified text writer.
DelimitedListTraceListener(TextWriter, String)	Initializes a new instance of the DelimitedListTraceListener class that writes to the specified text writer and has the specified name.

Properties

Attributes	Gets the custom trace listener attributes defined in the application configuration file. (Inherited from TraceListener)
Delimiter	Gets or sets the delimiter for the delimited list.
Filter	Gets or 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. (Inherited from TextWriterTraceListener)

Methods

Close()	Closes the Writer so that it no longer receives tracing or debugging output. (Inherited from TextWriterTraceListener)
CreateObjRef(Type)	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)	Disposes this TextWriterTraceListener object. (Inherited from TextWriterTraceListener)
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)
Flush()	Flushes the output buffer for the Writer. (Inherited from TextWriterTraceListener)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Obsolete. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetSupportedAttributes()	Returns the custom configuration file attribute supported by the delimited trace listener.
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeLifetimeService()	Obsolete. 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 output file or stream.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Writes trace information, an array of data objects, and event information to the output file or stream.
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 output file or stream.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Writes trace information, a formatted array of objects, and event information to the output file or stream.
TraceTransfer(TraceEventCache, String, Int32, String, Guid)	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(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)	Writes a message to this instance's Writer. (Inherited from TextWriterTraceListener)
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(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)	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). (Inherited from TextWriterTraceListener)
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)