BooleanSwitch Clase

Definición

Proporciona un modificador activado/desactivado simple que controla la generación de depuración y traza.Provides a simple on/off switch that controls debugging and tracing output.

public ref class BooleanSwitch : System::Diagnostics::Switch
public class BooleanSwitch : System.Diagnostics.Switch
type BooleanSwitch = class
    inherit Switch
Public Class BooleanSwitch
Inherits Switch
Herencia
BooleanSwitch

Ejemplos

En el ejemplo siguiente se BooleanSwitch crea un y se usa el modificador para determinar si se va a imprimir un mensaje de error.The following example creates a BooleanSwitch and uses the switch to determine whether to print an error message. El modificador se crea en el nivel de clase.You create the switch at the class level. El Main método pasa su ubicación a MyMethod, que imprime un mensaje de error y dónde se produjo el error.The Main method passes its location to MyMethod, which prints an error message and where the error occurred.

public ref class BooleanSwitchTest
{
private:

   /* Create a BooleanSwitch for data.*/
   static BooleanSwitch^ dataSwitch = gcnew BooleanSwitch( "Data","DataAccess module" );

public:
   static void MyMethod( String^ location )
   {
      
      //Insert code here to handle processing.
      if ( dataSwitch->Enabled )
            Console::WriteLine( "Error happened at {0}", location );
   }

};

int main()
{
   
   //Run the method which writes an error message specifying the location of the error.
   BooleanSwitchTest::MyMethod( "in main" );
}

// 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");
}

' Class level declaration.
' Create a BooleanSwitch for data. 
Private Shared dataSwitch As New BooleanSwitch("Data", "DataAccess module")


Public Shared Sub MyMethod(location As String)
    ' Insert code here to handle processing.
    If dataSwitch.Enabled Then
        Console.WriteLine(("Error happened at " + location))
    End If
End Sub

' Entry point which delegates to C-style main function.
Public Overloads Shared Sub Main()
    Main(System.Environment.GetCommandLineArgs())
End Sub
 
Overloads Public Shared Sub Main(args() As String)
    ' Run the method which writes an error message specifying the location of the error.
    MyMethod("in Main")
End Sub

Comentarios

Puede usar un modificador de seguimiento booleano para habilitar o deshabilitar los mensajes según su importancia.You can use a Boolean trace switch to enable or disable messages based on their importance. Utilice la Enabled propiedad para obtener el valor actual del modificador.Use the Enabled property to get the current value of the switch.

Puede habilitar o deshabilitar BooleanSwitch a través del archivo de configuración de la aplicación y, a continuación, usar el valor configurado BooleanSwitch en la aplicación.You can enable or disable a BooleanSwitch through the application configuration file and then use the configured BooleanSwitch value in your application. Como alternativa, puede crear un BooleanSwitch en el código y establecer la Enabled propiedad directamente para instrumentar una sección específica de código.Alternately, you can create a BooleanSwitch in your code and set the Enabled property directly to instrument a specific section of code.

Para configurar un BooleanSwitch, edite el archivo de configuración que se corresponde con el nombre de la aplicación.To configure a BooleanSwitch, edit the configuration file that corresponds to the name of your application. Dentro de este archivo, puede Agregar o quitar un modificador, establecer el valor de un modificador o borrar todos los modificadores previamente establecidos por la aplicación.Within this file, you can add or remove a switch, set a switch's value, or clear all the switches previously set by the application. El archivo de configuración debe tener el formato del siguiente ejemplo.The configuration file should be formatted like the following example.

<configuration>  
  <system.diagnostics>  
    <switches>  
      <add name="mySwitch" value="1"/>  
    </switches>  
  </system.diagnostics>  
</configuration>  

En esta sección de configuración de BooleanSwitch ejemplo se DisplayName define un con mySwitch la propiedad Enabled establecida en y trueel valor establecido en.This example configuration section defines a BooleanSwitch with the DisplayName property set to mySwitch and the Enabled value set to true. Dentro de la aplicación, puede usar el valor del modificador configurado mediante BooleanSwitch la creación de un con el mismo nombre, tal y como se muestra en el ejemplo de código siguiente.Within your application, you can use the configured switch value by creating a BooleanSwitch with the same name, as shown in the following code example.

private:
    static BooleanSwitch^ boolSwitch = gcnew BooleanSwitch("mySwitch",
        "Switch in config file");

public:
    static void Main( )
    {
        //...
        Console::WriteLine("Boolean switch {0} configured as {1}",
            boolSwitch->DisplayName, ((Boolean^)boolSwitch->Enabled)->ToString());
        if (boolSwitch->Enabled)
        {
            //...
        }
    }
private static BooleanSwitch boolSwitch = new BooleanSwitch("mySwitch",
    "Switch in config file");

public static void Main( )
{
    //...
    Console.WriteLine("Boolean switch {0} configured as {1}",
        boolSwitch.DisplayName, boolSwitch.Enabled.ToString());
    if (boolSwitch.Enabled)
    {
        //...
    }
}
Private Shared boolSwitch As new BooleanSwitch("mySwitch", _
    "Switch in config file")

Public Shared Sub Main( )
    '...
    Console.WriteLine("Boolean switch {0} configured as {1}",
        boolSwitch.DisplayName, boolSwitch.Enabled.ToString())
    If boolSwitch.Enabled = True Then
        '...
    End If
End Sub

De forma predeterminada, Enabled la propiedad se establece utilizando el valor especificado en el archivo de configuración.By default, the Enabled property is set using the value specified in the configuration file. Configure el modificador con un valor de 0 para Enabled establecer la falsepropiedad en; configure el modificador con un valor distinto Enabled de cero truepara establecer la propiedad en.Configure the switch with a value of 0 to set the Enabled property to false; configure the switch with a nonzero value to set the Enabled property to true. Si el BooleanSwitch constructor no encuentra la configuración inicial del conmutador en el archivo de Enabled configuración, la propiedad del nuevo modificador false se establece en de forma predeterminada.If the BooleanSwitch constructor cannot find initial switch settings in the configuration file, the Enabled property of the new switch is set to false by default.

Debe habilitar el seguimiento o la depuración para utilizar un modificador.You must enable tracing or debugging to use a switch. La sintaxis siguiente es específica del compilador.The following syntax is compiler specific. Si utiliza compiladores distintos de C# o Visual Basic, consulte la documentación del compilador.If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

  • Para habilitar la depuración en C#, /d:DEBUG agregue la marca a la línea de comandos del compilador al compilar #define DEBUG el código o puede agregarlo a la parte superior del archivo.To enable debugging in C#, add the /d:DEBUG flag to the compiler command line when you compile your code, or you can add #define DEBUG to the top of your file. En Visual Basic, agregue la /d:DEBUG=True marca a la línea de comandos del compilador.In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

  • Para habilitar el seguimiento C#en, agregue /d:TRACE la marca a la línea de comandos del compilador al compilar el código o agregue #define TRACE en la parte superior del archivo.To enable tracing in C#, add the /d:TRACE flag to the compiler command line when you compile your code, or add #define TRACE to the top of your file. En Visual Basic, agregue la /d:TRACE=True marca a la línea de comandos del compilador.In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

Nota

Estos modificadores de compilador de depuración y BooleanSwitch seguimiento no son necesarios cuando se usa la clase de aislamiento.These debug and trace compiler switches are not required when using the BooleanSwitch class in isolation. Solo se requieren junto con Trace los métodos o Debug que se compilan condicionalmente.They are only required in conjunction with Trace or Debug methods that are conditionally compiled.

Para obtener más información sobre cómo instrumentar la aplicación Debug , Tracevea y.For more information on instrumenting your application, see Debug and Trace. Para obtener más información sobre la configuración y el uso de modificadores de seguimiento, vea modificadores de seguimiento.For more information about configuring and using trace switches, see Trace Switches.

Nota

Para mejorar el rendimiento, puede crear BooleanSwitch miembros static en la clase.To improve performance, you can make BooleanSwitch members static in your class.

Constructores

BooleanSwitch(String, String)

Inicializa una nueva instancia de la clase BooleanSwitch con el nombre para mostrar y la descripción que se hayan especificado.Initializes a new instance of the BooleanSwitch class with the specified display name and description.

BooleanSwitch(String, String, String)

Inicializa una nueva instancia de la clase BooleanSwitch con el nombre para mostrar, la descripción y el valor de modificador predeterminado que se hayan especificado.Initializes a new instance of the BooleanSwitch class with the specified display name, description, and default switch value.

Propiedades

Attributes

Obtiene los atributos de modificador personalizados definidos en el archivo de configuración de la aplicación.Gets the custom switch attributes defined in the application configuration file.

(Heredado de Switch)
Description

Obtiene una descripción del modificador.Gets a description of the switch.

(Heredado de Switch)
DisplayName

Obtiene el nombre utilizado para identificar el modificador.Gets a name used to identify the switch.

(Heredado de Switch)
Enabled

Obtiene o establece un valor que indica si el modificador está habilitado o deshabilitado.Gets or sets a value indicating whether the switch is enabled or disabled.

SwitchSetting

Obtiene o establece la configuración actual de este modificador.Gets or sets the current setting for this switch.

(Heredado de Switch)
Value

Obtiene o establece el valor del modificador.Gets or sets the value of the switch.

(Heredado de Switch)

Métodos

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetSupportedAttributes()

Obtiene los atributos personalizados que admite el modificador.Gets the custom attributes supported by the switch.

(Heredado de Switch)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
OnSwitchSettingChanged()

Se invoca cuando cambia la propiedad SwitchSetting.Invoked when the SwitchSetting property is changed.

(Heredado de Switch)
OnValueChanged()

Determina si el nuevo valor de la propiedad Value se puede analizar como un valor Boolean.Determines whether the new value of the Value property can be parsed as a Boolean value.

ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Se aplica a

Consulte también: