TraceSource.Switch Property

Definition

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.TraceSource.dll

Source:

TraceSource.cs

Gets or sets the source switch value.

public:
 property System::Diagnostics::SourceSwitch ^ Switch { System::Diagnostics::SourceSwitch ^ get(); void set(System::Diagnostics::SourceSwitch ^ value); };

public System.Diagnostics.SourceSwitch Switch { get; set; }

member this.Switch : System.Diagnostics.SourceSwitch with get, set

Public Property Switch As SourceSwitch

Property Value

SourceSwitch

A SourceSwitch object representing the source switch value.

Exceptions

ArgumentNullException

Switch is set to null.

Remarks

The Switch property allows the filtering of messages before the trace source calls the listeners.

The switch is used to check whether trace calls should be generated or ignored. Each trace method calls the ShouldTrace method of the SourceSwitch to determine whether to proceed with the trace. If the call returns true, the listeners are called.