BooleanSwitch BooleanSwitch BooleanSwitch BooleanSwitch Class

Definizione

Viene fornita un'opzione di attivazione/disattivazione per il controllo dell'output del debug e di tracciatura.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
Ereditarietà
BooleanSwitchBooleanSwitchBooleanSwitchBooleanSwitch

Esempi

Nell'esempio seguente viene creato BooleanSwitch un oggetto e viene utilizzata l'opzione per determinare se stampare un messaggio di errore.The following example creates a BooleanSwitch and uses the switch to determine whether to print an error message. Si crea l'opzione a livello di classe.You create the switch at the class level. Il Main metodo passa la posizione a MyMethod, che stampa un messaggio di errore e il punto in cui si è verificato l'errore.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 'MyMethod

' 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 'Main

Commenti

È possibile utilizzare un'opzione di traccia booleana per abilitare o disabilitare i messaggi in base alla relativa importanza.You can use a Boolean trace switch to enable or disable messages based on their importance. Utilizzare la Enabled proprietà per ottenere il valore corrente dell'opzione.Use the Enabled property to get the current value of the switch.

È possibile abilitare o disabilitare un BooleanSwitch tramite il file di configurazione dell'applicazione e quindi usare BooleanSwitch il valore configurato nell'applicazione.You can enable or disable a BooleanSwitch through the application configuration file and then use the configured BooleanSwitch value in your application. In alternativa, è possibile creare un BooleanSwitch oggetto nel codice e impostare la Enabled proprietà direttamente per instrumentare una sezione di codice specifica.Alternately, you can create a BooleanSwitch in your code and set the Enabled property directly to instrument a specific section of code.

Per configurare un BooleanSwitch, modificare il file di configurazione che corrisponde al nome dell'applicazione.To configure a BooleanSwitch, edit the configuration file that corresponds to the name of your application. All'interno di questo file è possibile aggiungere o rimuovere un'opzione, impostare il valore di un commutatore o deselezionare tutte le opzioni precedentemente impostate dall'applicazione.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. Il file di configurazione deve essere formattato come l'esempio seguente.The configuration file should be formatted like the following example.

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

In questa sezione di configurazione di BooleanSwitch esempio viene DisplayName definito un oggetto mySwitch con la Enabled proprietà impostata su truee il valore impostato su.This example configuration section defines a BooleanSwitch with the DisplayName property set to mySwitch and the Enabled value set to true. All'interno dell'applicazione, è possibile usare il valore di opzione configurato creando BooleanSwitch un con lo stesso nome, come illustrato nell'esempio di codice seguente.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

Per impostazione predefinita, Enabled la proprietà viene impostata usando il valore specificato nel file di configurazione.By default, the Enabled property is set using the value specified in the configuration file. Configurare l'opzione con un valore pari a 0 per impostare Enabled la proprietà falsesu; configurare l'opzione con un valore diverso da zero per Enabled impostare la trueproprietà su.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. Se il BooleanSwitch costruttore non riesce a trovare le impostazioni del cambio iniziale nel file Enabled di configurazione, la proprietà della nuova opzione false è impostata su per impostazione predefinita.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.

È necessario abilitare la traccia o il debug per usare un'opzione.You must enable tracing or debugging to use a switch. La sintassi seguente è specifica del compilatore.The following syntax is compiler specific. Se si usano compilatori diversi C# da o Visual Basic, fare riferimento alla documentazione del compilatore.If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

  • Per abilitare il debug C#in, aggiungere /d:DEBUG il flag alla riga di comando del compilatore quando si compila il codice oppure è possibile #define DEBUG aggiungerlo all'inizio del file.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. In Visual Basic aggiungere il /d:DEBUG=True flag alla riga di comando del compilatore.In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

  • Per abilitare l'analisi C#in, aggiungere /d:TRACE il flag alla riga di comando del compilatore quando si compila il codice oppure #define TRACE aggiungerlo all'inizio del file.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. In Visual Basic aggiungere il /d:TRACE=True flag alla riga di comando del compilatore.In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

Nota

Queste opzioni del compilatore di debug e di traccia non sono necessarie BooleanSwitch quando si usa la classe in isolamento.These debug and trace compiler switches are not required when using the BooleanSwitch class in isolation. Sono necessarie solo in combinazione con Trace i metodi o Debug compilati in modo condizionale.They are only required in conjunction with Trace or Debug methods that are conditionally compiled.

Per ulteriori informazioni sulla strumentazione dell'applicazione, vedere Debug e. TraceFor more information on instrumenting your application, see Debug and Trace. Per ulteriori informazioni sulla configurazione e sull'utilizzo delle opzioni di traccia, vedere Opzioni di traccia.For more information about configuring and using trace switches, see Trace Switches.

Nota

Per migliorare le prestazioni, è possibile BooleanSwitch fare static in modo che i membri della classe.To improve performance, you can make BooleanSwitch members static in your class.

Costruttori

BooleanSwitch(String, String) BooleanSwitch(String, String) BooleanSwitch(String, String) BooleanSwitch(String, String)

Inizializza una nuova istanza della classe BooleanSwitch con il nome e la descrizione specificati.Initializes a new instance of the BooleanSwitch class with the specified display name and description.

BooleanSwitch(String, String, String) BooleanSwitch(String, String, String) BooleanSwitch(String, String, String) BooleanSwitch(String, String, String)

Inizializza una nuova istanza della classe BooleanSwitch con il nome, la descrizione e il valore predefinito specificati per l'opzione.Initializes a new instance of the BooleanSwitch class with the specified display name, description, and default switch value.

Proprietà

Attributes Attributes Attributes Attributes

Ottiene gli attributi di opzione personalizzati definiti nel file di configurazione dell'applicazione.Gets the custom switch attributes defined in the application configuration file.

(Inherited from Switch)
Description Description Description Description

Ottiene una descrizione dell'opzione.Gets a description of the switch.

(Inherited from Switch)
DisplayName DisplayName DisplayName DisplayName

Ottiene un nome utilizzato per identificare l'opzione.Gets a name used to identify the switch.

(Inherited from Switch)
Enabled Enabled Enabled Enabled

Ottiene o imposta un valore che indica se l'opzione è attivata o disabilitata.Gets or sets a value indicating whether the switch is enabled or disabled.

SwitchSetting SwitchSetting SwitchSetting SwitchSetting

Ottiene o imposta il nome corrente per questa opzione.Gets or sets the current setting for this switch.

(Inherited from Switch)
Value Value Value Value

Ottiene o imposta il valore dell'opzione.Gets or sets the value of the switch.

(Inherited from Switch)

Metodi

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Inherited from Object)
GetSupportedAttributes() GetSupportedAttributes() GetSupportedAttributes() GetSupportedAttributes()

Ottiene gli attributi personalizzati supportati dall'opzione.Gets the custom attributes supported by the switch.

(Inherited from Switch)
GetType() GetType() GetType() GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
OnSwitchSettingChanged() OnSwitchSettingChanged() OnSwitchSettingChanged() OnSwitchSettingChanged()

Viene richiamato quando si modifica la proprietà SwitchSetting.Invoked when the SwitchSetting property is changed.

(Inherited from Switch)
OnValueChanged() OnValueChanged() OnValueChanged() OnValueChanged()

Determina se il nuovo valore della proprietà Value può essere analizzato come valore Boolean.Determines whether the new value of the Value property can be parsed as a Boolean value.

ToString() ToString() ToString() ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Si applica a

Vedi anche