This documentation is archived and is not being maintained.

Switch Constructor (String, String)

Initializes a new instance of the Switch class.

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

protected Switch(
	string displayName,
	string description


Type: System.String
The name of the switch.
Type: System.String
The description for the switch.

When you create a new Switch object, the value of the displayName parameter is used to find initial switch settings. The default value is an empty string ("").

Within the XML configuration file, you can add a switch and set its value, remove a switch, or clear all the switches previously set by the application. Dynamic changes to the configuration file are not detected while the application is executing. You must stop and restart an application before changes to the configuration file take effect. The configuration file should be formatted like the following example:

      <add name="mySwitch" value="10" />
      <add name="myNewSwitch" value="20" />
      <remove name="mySwitch" />

Notes to Inheritors

To set the value of the switch, set the SwitchSetting property in the constructor.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.