Level Property
Collapse the table of content
Expand the table of content

TraceSwitch.Level Property

Gets or sets the trace level that specifies the messages to output for tracing and debugging.

[Visual Basic]
Public Property Level As TraceLevel
[C#]
public TraceLevel Level {get; set;}
[C++]
public: __property TraceLevel get_Level();
public: __property void set_Level(TraceLevel);
[JScript]
public function get Level() : TraceLevel;
public function set Level(TraceLevel);

Property Value

One of the TraceLevel values that specify the messages to output for tracing and debugging.

Exceptions

Exception Type Condition
ArgumentException Setting the level to a value not in the TraceLevel enumeration.

Remarks

To set the level of your TraceSwitch, edit the configuration file that corresponds to the name of your application. Within this file, you can add a switch and set its value, remove a switch, or clear all the switches previously set by the application. The configuration file should be formatted like the following example:

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

When the TraceSwitch constructor cannot find initial switch settings in the configuration file, the Level of the new switch is set to TraceLevel.Off.

Setting this property will update the TraceError, TraceWarning, TraceInfo, and TraceVerbose properties in this class to the new value.

Example

[Visual Basic, C#, C++] The following example creates a new TraceSwitch and uses the switch to determine whether to print error messages. The switch is created at the class level. MyMethod will write the first error message if the Level is set to TraceError or higher. However, MyMethod will not write the second error message when the Level is less than TraceVerbose.

[Visual Basic] 
' Class-level declaration.
' Create a TraceSwitch to use in the entire application. 

Private Shared mySwitch As New TraceSwitch("General", "Entire Application")    

Public Shared Sub MyMethod()
    ' Write the message if the TraceSwitch level is set to Error or higher.
    If mySwitch.TraceError Then
        Console.WriteLine("My error message.")
    End If 
    ' Write the message if the TraceSwitch level is set to Verbose.
    If mySwitch.TraceVerbose Then
        Console.WriteLine("My second error message.")
    End If
End Sub

Public Shared Sub Main()
    ' Run the method that prints error messages based on the switch level.
    MyMethod()
End Sub


[C#] 
//Class-level declaration.
 /* Create a TraceSwitch to use in the entire application.*/
 
 static TraceSwitch mySwitch = new TraceSwitch("General", "Entire Application");
 
 static public void MyMethod() {
    // Write the message if the TraceSwitch level is set to Error or higher.
    if(mySwitch.TraceError)
       Console.WriteLine("My error message.");
 
    // Write the message if the TraceSwitch level is set to Verbose.
    if(mySwitch.TraceVerbose)
       Console.WriteLine("My second error message.");
 }
 
 public static void Main(string[] args) {
    // Run the method that prints error messages based on the switch level.
    MyMethod();
 }


[C++] 
//Class-level declaration.
 /* Create a TraceSwitch to use in the entire application.*/
 
 static TraceSwitch* mySwitch = new TraceSwitch(S"General", S"Entire Application");
 
public:
 static void MyMethod() {
    // Write the message if the TraceSwitch level is set to Error or higher.
    if(mySwitch->TraceError)
       Console::WriteLine(S"My error message.");
 
    // Write the message if the TraceSwitch level is set to Verbose.
    if(mySwitch->TraceVerbose)
       Console::WriteLine(S"My second error message.");
 }
 
 static void main() {
    // Run the method that prints error messages based on the switch level.
    MyMethod();
 }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

TraceSwitch Class | TraceSwitch Members | System.Diagnostics Namespace | TraceSwitch | TraceLevel | Switch | Debug | Trace

Show:
© 2016 Microsoft