Export (0) Print
Expand All
Expand Minimize

TraceOptions Enumeration

Note: This enumeration is new in the .NET Framework version 2.0.

Specifies trace data options to be written to the trace output.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace: System.Diagnostics
Assembly: System (in system.dll)

[FlagsAttribute] 
public enum TraceOptions
/** @attribute FlagsAttribute() */ 
public enum TraceOptions
FlagsAttribute 
public enum TraceOptions

 Member nameDescription
CallstackWrite the call stack, which is represented by the return value of the Environment.StackTrace property. 
DateTimeWrite the date and time.  
LogicalOperationStackWrite the logical operation stack, which is represented by the return value of the CorrelationManager.LogicalOperationStack property. 
NoneDo not write any elements. 
ProcessIdWrite the process identity, which is represented by the return value of the Process.Id property. 
ThreadIdWrite the thread identity, which is represented by the return value of the Thread.ManagedThreadId property for the current thread. 
TimestampWrite the timestamp, which is represented by the return value of the System.Diagnostics.Stopwatch.GetTimeStamp method. 

This enumeration is used by trace listeners to determine which options, or elements, should be included in the trace output. Trace listeners store the trace options in the TraceOutputOptions property.

The following example shows the use of the traceOutputOptions attribute to specify the trace output options for a ConsoleTraceListener that is enabled using a configuration file.

<configuration>
  <system.diagnostics>
    <trace autoflush="false" indentsize="4">
      <listeners>
        <add name="consoleListener"
          type="System.Diagnostics.ConsoleTraceListener" 
          traceOutputOptions="ProcessId, DateTime" />
      </listeners>
    </trace>
  </system.diagnostics>
</configuration>

For details about adding trace listeners in the application configuration file, see <listeners> Element for <trace>.

The following code example shows the use of the TraceOptions enumeration to programmatically set the TraceOutputOptions property for a console trace listener. The console trace listener is one of the listeners enumerated in the Listeners property of a trace source. This code example is part of a larger example provided for the TraceSource class.

ts.Listeners["console"].TraceOutputOptions |= TraceOptions.Callstack;

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft