This documentation is archived and is not being maintained.

Switch.Switch(String, String) Constructor

Initializes a new instance of the Switch class.

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

protected Switch (
	string displayName,
	string description
)
protected Switch (
	String displayName, 
	String description
)
protected function Switch (
	displayName : String, 
	description : String
)
Not applicable.

Parameters

displayName

The name of the switch.

description

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:

<configuration>
  <system.diagnostics>
    <switches>
      <add name="mySwitch" value="10" />
      <add name="myNewSwitch" value="20" />
      <remove name="mySwitch" />
      <clear/>
    </switches>
  </system.diagnostics>
</configuration>

Notes to Inheritors: To set the value of the switch, set the SwitchSetting property in the constructor.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: