.NET Framework Class Library
DelimitedListTraceListener Class

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

Namespace:   System.Diagnostics
Assembly:  System (in System.dll)
Syntax
<[%$TOPIC/8yacsy65_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/8yacsy65_en-us_VS_110_2_0_0_0_1%].LinkDemand, Synchronization := True)> _
Public Class DelimitedListTraceListener _
	Inherits [%$TOPIC/8yacsy65_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/8yacsy65_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/8yacsy65_en-us_VS_110_2_0_1_0_1%].LinkDemand, Synchronization = true)]
public class DelimitedListTraceListener : [%$TOPIC/8yacsy65_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/8yacsy65_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/8yacsy65_en-us_VS_110_2_0_2_0_1%]::LinkDemand, Synchronization = true)]
public ref class DelimitedListTraceListener : public [%$TOPIC/8yacsy65_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/8yacsy65_en-us_VS_110_2_0_3_0_0%]([%$TOPIC/8yacsy65_en-us_VS_110_2_0_3_0_1%].LinkDemand, Synchronization = true)>]
type DelimitedListTraceListener =  
    class 
        inherit [%$TOPIC/8yacsy65_en-us_VS_110_2_0_3_0_2%] 
    end

The DelimitedListTraceListener type exposes the following members.

Constructors
  NameDescription
Public method DelimitedListTraceListener(Stream)Initializes a new instance of the DelimitedListTraceListener class that writes to the specified output stream.
Public method DelimitedListTraceListener(String)Initializes a new instance of the DelimitedListTraceListener class that writes to the specified file.
Public method DelimitedListTraceListener(TextWriter)Initializes a new instance of the DelimitedListTraceListener class that writes to the specified text writer.
Public method DelimitedListTraceListener(Stream, String)Initializes a new instance of the DelimitedListTraceListener class that writes to the specified output stream and has the specified name.
Public method DelimitedListTraceListener(String, String)Initializes a new instance of the DelimitedListTraceListener class that writes to the specified file and has the specified name.
Public method DelimitedListTraceListener(TextWriter, String)Initializes a new instance of the DelimitedListTraceListener class that writes to the specified text writer and has the specified name.
Top
Properties
  NameDescription
Public property AttributesGets the custom trace listener attributes defined in the application configuration file. (Inherited from TraceListener.)
Public property DelimiterGets or sets the delimiter for the delimited list.
Public property FilterGets and sets the trace filter for the trace listener. (Inherited from TraceListener.)
Public property IndentLevelGets or sets the indent level. (Inherited from TraceListener.)
Public property 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 NameGets or sets a name for this TraceListener. (Inherited from TraceListener.)
Protected property 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 WriterGets or sets the text writer that receives the tracing or debugging output. (Inherited from TextWriterTraceListener.)
Top
Methods
  NameDescription
Public method CloseCloses the Writer so that it no longer receives tracing or debugging output. (Inherited from TextWriterTraceListener.)
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 DisposeReleases all resources used by the TraceListener. (Inherited from TraceListener.)
Protected method Dispose(Boolean)Infrastructure. Disposes this TextWriterTraceListener object. (Inherited from TextWriterTraceListener.)
Public method Equals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Fail(String)Emits an error message to the listener you create when you implement the TraceListener class. (Inherited from TraceListener.)
Public method 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 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 FlushFlushes the output buffer for the Writer. (Inherited from TextWriterTraceListener.)
Public method 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 GetSupportedAttributesReturns the custom configuration file attribute supported by the delimited trace listener. (Overrides TraceListenerGetSupportedAttributes.)
Public method 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 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 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 output file or stream. (Overrides TraceListenerTraceData(TraceEventCache, String, TraceEventType, Int32, Object).)
Public method TraceData(TraceEventCache, String, TraceEventType, Int32, Object)Writes trace information, an array of data objects, and event information to the output file or stream. (Overrides TraceListenerTraceData(TraceEventCache, String, TraceEventType, Int32, Object).)
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 output file or stream. (Overrides TraceListenerTraceEvent(TraceEventCache, String, TraceEventType, Int32, String).)
Public method TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object)Writes trace information, a formatted array of objects, and event information to the output file or stream. (Overrides TraceListenerTraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object).)
Public method TraceTransferWrites trace information, a message, a related activity identity and event information to the listener specific output. (Inherited from TraceListener.)
Public method 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 Write(String)Writes a message to this instance's Writer. (Inherited from TextWriterTraceListener.)
Public method 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 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 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 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 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.)
Public method 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 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 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 noteImportant

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 enable or disable a DelimitedListTraceListener through the application configuration file and then use the configured DelimitedListTraceListener in your application. Alternately, you can create a DelimitedListTraceListener in your code.

NoteNote

The DelimitedListTraceListener delimits only text that is emitted by using the methods that have names starting with the word Trace, such as DelimitedListTraceListenerTraceEvent or TraceTraceWarning. Trace data that is emitted by using the DebugWrite and TextWriterTraceListenerWriteLine methods is not delimited.

To configure a DelimitedListTraceListener, 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>
NoteNote

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

NoteNote

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.

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.

Version Information

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows Phone 8.1, Windows Phone 8, 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.