SourceSwitch Class

Provides a multilevel switch to control tracing and debug output without recompiling your code.


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

Public Class SourceSwitch _
	Inherits Switch

The SourceSwitch type exposes the following members.

Public methodSourceSwitch(String)Initializes a new instance of the SourceSwitch class, specifying the name of the source.
Public methodSourceSwitch(String, String)Initializes a new instance of the SourceSwitch class, specifying the display name and the default value for the source switch.

Public propertyAttributesGets the custom switch attributes defined in the application configuration file. (Inherited from Switch.)
Public propertyDescriptionGets a description of the switch. (Inherited from Switch.)
Public propertyDisplayNameGets a name used to identify the switch. (Inherited from Switch.)
Public propertyLevelGets or sets the level of the switch.
Protected propertySwitchSettingGets or sets the current setting for this switch. (Inherited from Switch.)
Protected propertyValueGets or sets the value of the switch. (Inherited from Switch.)

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetSupportedAttributesGets the custom attributes supported by the switch. (Inherited from Switch.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnSwitchSettingChangedInvoked when the SwitchSetting property is changed. (Inherited from Switch.)
Protected methodOnValueChangedInvoked when the value of the Value property changes. (Overrides Switch.OnValueChanged.)
Public methodShouldTraceDetermines if trace listeners should be called, based on the trace event type.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The Switch property of the TraceSource class is a SourceSwitch object. The SourceSwitch class provides a Level property to test the event level of the switch. The Level property gets or sets the switch's TraceLevel value.

You can set the event level of a SourceSwitch through the application configuration file and then use the configured SourceSwitch level in your application. Alternatively, you can create a SourceSwitch in your code and set the level directly, to instrument a specific section of code.

To configure a SourceSwitch, edit the configuration file that corresponds to the name of your application. Within this file, you can set a switch's value or clear all the switches previously set by the application. The configuration file should be formatted as shown in the following example.

  <add name="SourceSwitch" value="Verbose"></add>

The switch is used to check whether a trace should be propagated or ignored. Each TraceSource trace method calls the ShouldTrace method before calling the listeners. If the ShouldTrace method returns false, the trace is ignored and the trace method exits. If the ShouldTrace method returns true, the trace is passed to the listeners.

How to: Configure Trace Switches.NET Framework: Debugging
How to: Create and Initialize Trace Switches.NET Framework: Debugging
How to: Configure Trace Switches.NET Framework: Debugging
How to: Create and Initialize Trace Switches.NET Framework: Debugging

.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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft