Expand Minimize

TraceOptions Enumeration

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

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 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 to the application configuration file, see <listeners> Element for <trace>.

The TraceOptions enumeration is not used by the following classes and methods:

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;

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft