TraceListener.TraceOutputOptions Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the trace output options.
public:
property System::Diagnostics::TraceOptions TraceOutputOptions { System::Diagnostics::TraceOptions get(); void set(System::Diagnostics::TraceOptions value); };public System.Diagnostics.TraceOptions TraceOutputOptions { get; set; }[System.Runtime.InteropServices.ComVisible(false)]
public System.Diagnostics.TraceOptions TraceOutputOptions { get; set; }member this.TraceOutputOptions : System.Diagnostics.TraceOptions with get, set[<System.Runtime.InteropServices.ComVisible(false)>]
member this.TraceOutputOptions : System.Diagnostics.TraceOptions with get, setPublic Property TraceOutputOptions As TraceOptionsProperty Value
A bitwise combination of the enumeration values. The default is None.
- Attributes
Exceptions
Set operation failed because the value is invalid.
Examples
The following example shows the setting of 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;
ts.Listeners("console").TraceOutputOptions = ts.Listeners("console").TraceOutputOptions Or TraceOptions.Callstack
Remarks
The TraceOutputOptions property determines the optional content of trace output. The property can be set in the configuration file or programmatically during execution to include additional data specifically for a section of code. For example, you can set the TraceOutputOptions property for the console trace listener to TraceOptions.Callstack to add call stack information to the trace output.
The TraceOptions enumeration is not used by the following classes and methods:
The EventLogTraceListener class, because it can cause a large volume of data to be written to the log.
The
WriteandWriteLinemethods of the ConsoleTraceListener, DefaultTraceListener, and TextWriterTraceListener classes.The Write and WriteLine methods of the TraceListener class when they are not overridden in a derived class.
