TraceSwitch.TraceError Property

Reference

Definition

Namespace:: System.Diagnostics

Assembly:: System.Diagnostics.TraceSource.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: TraceSwitch.cs

Source:: TraceSwitch.cs

Source:: TraceSwitch.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a value indicating whether the switch allows error-handling messages.

public:
 property bool TraceError { bool get(); };

public bool TraceError { get; }

member this.TraceError : bool

Public ReadOnly Property TraceError As Boolean

Property Value

Boolean

true if the Level property is set to Error, Warning, Info, or Verbose; otherwise, false.

Examples

The following code example creates a new TraceSwitch and uses the switch to determine whether to emit error messages. The switch is created at the class level. MyMethod writes the first error message if the Level property is set to TraceLevel.Error or higher. However, MyMethod does not write the second error message if the Level is less than TraceLevel.Verbose.

   // Class-level declaration.
   /* Create a TraceSwitch to use in the entire application.*/
private:
   static TraceSwitch^ mySwitch = gcnew TraceSwitch( "General", "Entire Application" );

public:
   static 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." );
   }

   static void main()
   {
      // Run the method that prints error messages based on the switch level.
      MyMethod();
   }

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

' 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

Remarks

You can use the TraceError, TraceWarning, TraceInfo, and TraceVerbose properties in conjunction with the Debug and Trace classes to emit all messages with a specified importance or greater. When the Level property is set to the highest importance, TraceLevel.Error, Error , only error-handling messages are emitted.

Applies to

Jaa