TraceOptions Enumeration
TOC
Collapse the table of content
Expand the table of content

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
Callstack

Write the call stack, which is represented by the return value of the Environment.StackTrace property.

DateTime

Write the date and time.

LogicalOperationStack

Write the logical operation stack, which is represented by the return value of the CorrelationManager.LogicalOperationStack property.

None

Do not write any elements.

ProcessId

Write the process identity, which is represented by the return value of the Process.Id property.

ThreadId

Write the thread identity, which is represented by the return value of the Thread.ManagedThreadId property for the current thread.

Timestamp

Write 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
Available since 2.0
Return to top
Show:
© 2016 Microsoft