BooleanSwitch Constructor (String, String)

 

Initializes a new instance of the BooleanSwitch class with the specified display name and description.

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

public BooleanSwitch(
	string displayName,
	string description
)

Parameters

displayName
Type: System.String

The name to display on a user interface.

description
Type: System.String

The description of the switch.

When you create a BooleanSwitch, the displayName parameter is used to find initial switch settings. If the constructor cannot find initial settings, the Enabled property is set to false (disabled).

To set the level of your BooleanSwitch, edit the configuration file corresponding to the name of your application. Within this file, you can add a switch and set its value, remove a switch, or clear all switches previously set by the application. 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>
System_CAPS_noteNote

The switches you created should be static.

The following example creates a BooleanSwitch and uses the switch to determine whether to print an error message. The switch is created at the class level. The Main method passes its location to MyMethod, which prints an error message and where the error occurred.

// Class level declaration.
/* Create a BooleanSwitch for data.*/
static BooleanSwitch dataSwitch = new BooleanSwitch("Data", "DataAccess module");

static public void MyMethod(string location) {
   //Insert code here to handle processing.
   if(dataSwitch.Enabled)
      Console.WriteLine("Error happened at " + location);
}

public static void Main(string[] args) {
   //Run the method which writes an error message specifying the location of the error.
   MyMethod("in Main");
}

.NET Framework
Available since 1.1
Return to top
Show: