Debug.WriteIf Method

Reference

Definition

Namespace:: System.Diagnostics

Assembly:: System.Runtime.dll

Assembly:: System.Diagnostics.Debug.dll

Assembly:: System.dll

Assembly:: netstandard.dll

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.

Writes information about the debug to the trace listeners in the Listeners collection if a condition is true.

Overloads

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler)	If `condition` is `true`, writes a category name and message to the trace listeners in the Listeners collection.
WriteIf(Boolean, Object)	Writes the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is `true`.
WriteIf(Boolean, String)	Writes a message to the trace listeners in the Listeners collection if a condition is `true`.
WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)	Writes a category name and message to the trace listeners in the Listeners collection if a specified condition is `true`.
WriteIf(Boolean, Object, String)	Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is `true`.
WriteIf(Boolean, String, String)	Writes a category name and message to the trace listeners in the Listeners collection if a condition is `true`.

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

If condition is true, writes a category name and message to the trace listeners in the Listeners collection.

public:
 static void WriteIf(bool condition, System::Diagnostics::Debug::WriteIfInterpolatedStringHandler % message);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteIf : bool * WriteIfInterpolatedStringHandler -> unit

Public Shared Sub WriteIf (condition As Boolean, ByRef message As Debug.WriteIfInterpolatedStringHandler)

Parameters

condition: Boolean

The conditional expression to evaluate. If the condition is true, the value is written to the trace listeners in the collection.

message: Debug.WriteIfInterpolatedStringHandler

The message to write if condition is true.

Attributes: ConditionalAttribute

Remarks

This overload was introduced in .NET 6 to improve performance. In comparison to the overloads that take a String parameter, this overload only evaluates any interpolated string formatting items if the message is required.

By default, the output is written to an instance of DefaultTraceListener.

Use the category parameter to group output messages.

This method calls the Write method of the trace listener.

Applies to

WriteIf(Boolean, Object)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is true.

public:
 static void WriteIf(bool condition, System::Object ^ value);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object value);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object? value);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteIf : bool * obj -> unit

Public Shared Sub WriteIf (condition As Boolean, value As Object)

Parameters

condition: Boolean

The conditional expression to evaluate. If the condition is true, the value is written to the trace listeners in the collection.

value: Object

An object whose name is sent to the Listeners.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

If the switch is set to the TraceLevel Error or higher, the example outputs the first name of the value parameter to the Listeners. For information on adding a listener to the Listeners collection, see the TraceListenerCollection class.

Then, if the TraceLevel is set to Verbose, the example outputs a message on the same line as the first message. A line terminator follows the second message.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod( Object^ myObject )
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      #if defined(DEBUG)
      Debug::WriteIf( generalSwitch->TraceError, myObject );
      
      // Write a second message if the TraceSwitch level is set to Verbose.
      Debug::WriteLineIf( generalSwitch->TraceVerbose, 
         " is not a valid value for this method." );
      #endif
   }

// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject)
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    Debug.WriteIf(generalSwitch.TraceError, myObject);

    // Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteLineIf(generalSwitch.TraceVerbose, " is not a valid value for this method.");
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod(myObject As Object)
    ' Write the message if the TraceSwitch level is set to Error or higher.
    Debug.WriteIf(generalSwitch.TraceError, myObject)
    
    ' Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteLineIf(generalSwitch.TraceVerbose, " is not a valid value for this method.")
End Sub

Remarks

By default, the output is written to an instance of DefaultTraceListener.

This method calls the Write method of the trace listener.

Notes to Inheritors

You can minimize the performance penalty of instrumenting your application by using If...Then statements instead of using WriteIf(Boolean, String) statements. The following two code examples send the same debugging message. However, the first example is much faster when tracing is off, because if mySwitch.TraceError evaluates to false, you do not call Write(String). The second example always calls WriteIf(Boolean, String), even when mySwitch.TraceError is false and no tracing output is produced. This can result in unnecessary execution of arbitrarily complex code.

First example:

if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Second example:

Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

Applies to

WriteIf(Boolean, String)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes a message to the trace listeners in the Listeners collection if a condition is true.

public:
 static void WriteIf(bool condition, System::String ^ message);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string message);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string? message);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteIf : bool * string -> unit

Public Shared Sub WriteIf (condition As Boolean, message As String)

Parameters

condition: Boolean

The conditional expression to evaluate. If the condition is true, the message is written to the trace listeners in the collection.

message: String

A message to write.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

If the switch is set to the TraceLevel Error or higher, the example outputs the first error message to the Listeners. For information about adding a listener to the Listeners collection, see the TraceListenerCollection class.

Then, if the TraceLevel is set to Verbose, the example outputs the second error message on the same line as the first message. A line terminator follows the second message.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod()
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      #if defined(DEBUG)
      Debug::WriteIf( generalSwitch->TraceError, "My error message. " );
      
      // Write a second message if the TraceSwitch level is set to Verbose.
      Debug::WriteIf( generalSwitch->TraceVerbose, 
         "My second error message." );
      #endif
   }

// Class-level declaration.
// Create a TraceSwitch.
TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static void MyErrorMethod()
{
    // Write the message if the TraceSwitch level is set to Error or higher.
    Debug.WriteIf(generalSwitch.TraceError, "My error message. ");

    // Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, "My second error message.");
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod()
    ' Write the message if the TraceSwitch level is set to Error or higher.
    Debug.WriteIf(generalSwitch.TraceError, "My error message. ")
    
    ' Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, "My second error message.")
End Sub

Remarks

By default, the output is written to an instance of DefaultTraceListener.

This method calls the Write method of the trace listener.

Notes to Inheritors

First example:

if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Second example:

Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

Applies to

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes a category name and message to the trace listeners in the Listeners collection if a specified condition is true.

public:
 static void WriteIf(bool condition, System::Diagnostics::Debug::WriteIfInterpolatedStringHandler % message, System::String ^ category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, ref System.Diagnostics.Debug.WriteIfInterpolatedStringHandler message, string? category);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteIf : bool * WriteIfInterpolatedStringHandler * string -> unit

Public Shared Sub WriteIf (condition As Boolean, ByRef message As Debug.WriteIfInterpolatedStringHandler, category As String)

Parameters

condition: Boolean

The conditional expression to evaluate. If the condition is true, the message is written to the trace listeners in the collection.

message: Debug.WriteIfInterpolatedStringHandler

The message to write.

category: String

A category name used to organize the output.

Attributes: ConditionalAttribute

Remarks

By default, the output is written to an instance of DefaultTraceListener.

Use the category parameter to group output messages.

This method calls the Write method of the trace listener.

Applies to

WriteIf(Boolean, Object, String)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes a category name and the value of the object's ToString() method to the trace listeners in the Listeners collection if a condition is true.

public:
 static void WriteIf(bool condition, System::Object ^ value, System::String ^ category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object value, string category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, object? value, string? category);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteIf : bool * obj * string -> unit

Public Shared Sub WriteIf (condition As Boolean, value As Object, category As String)

Parameters

condition: Boolean

The conditional expression to evaluate. If the condition is true, the category name and value are written to the trace listeners in the collection.

value: Object

An object whose name is sent to the Listeners.

category: String

A category name used to organize the output.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

If the switch is set to the TraceLevel Verbose, the example outputs the name of the myObject and the category to the Listeners. For information on adding a listener to the Listeners collection, see the TraceListenerCollection class.

Then, if the TraceLevel is set to Error or higher, the example outputs the second error message on the same line as the first message. A line terminator follows the second message.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod( Object^ myObject, String^ category )
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      #if defined(DEBUG)
      Debug::WriteIf( generalSwitch->TraceVerbose, myObject, category );
      
      // Write a second message if the TraceSwitch level is set to Verbose.
      Debug::WriteLineIf( generalSwitch->TraceError, 
         " Object is not valid for this category." );
      #endif
   }

// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject, string category)
{
    // Write the message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, myObject, category);

    // Write a second message if the TraceSwitch level is set to Error or higher.
    Debug.WriteLineIf(generalSwitch.TraceError, " Object is not valid for this category.");
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod(myObject As Object, category As String)
    ' Write the message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, myObject, category)
    
    ' Write a second message if the TraceSwitch level is set to Error or higher.
    Debug.WriteLineIf(generalSwitch.TraceError, " Object is not valid for this category.")
End Sub

Remarks

By default, the output is written to an instance of DefaultTraceListener.

The category parameter can be used to group output messages.

This method calls the Write method of the trace listener.

Notes to Inheritors

First example:

if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Second example:

Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

Applies to

WriteIf(Boolean, String, String)

Source:: Debug.cs

Source:: Debug.cs

Source:: Debug.cs

Writes a category name and message to the trace listeners in the Listeners collection if a condition is true.

public:
 static void WriteIf(bool condition, System::String ^ message, System::String ^ category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string message, string category);

[System.Diagnostics.Conditional("DEBUG")]
public static void WriteIf (bool condition, string? message, string? category);

[<System.Diagnostics.Conditional("DEBUG")>]
static member WriteIf : bool * string * string -> unit

Public Shared Sub WriteIf (condition As Boolean, message As String, category As String)

Parameters

condition: Boolean

The conditional expression to evaluate. If the condition is true, the category name and message are written to the trace listeners in the collection.

message: String

A message to write.

category: String

A category name used to organize the output.

Attributes: ConditionalAttribute

Examples

The following example creates a TraceSwitch named generalSwitch. This switch is set outside of the code sample.

If the switch is set to the TraceLevel Verbose, the example outputs the first error message to the Listeners. For information on adding a listener to the Listeners collection, see the TraceListenerCollection class.

Then, if the TraceLevel is set to Error or higher, the example outputs the second error message on the same line as the first message. A line terminator follows the second message.

   // Class-level declaration.
   // Create a TraceSwitch.
   static TraceSwitch^ generalSwitch = 
      gcnew TraceSwitch( "General","Entire Application" );

public:
   static void MyErrorMethod( Object^ myObject, String^ category )
   {
      // Write the message if the TraceSwitch level is set to Error or higher.
      #if defined(DEBUG)
      Debug::WriteIf( generalSwitch->TraceVerbose, String::Concat( myObject, 
         " is not a valid object for category: " ), category );
      
      // Write a second message if the TraceSwitch level is set to Verbose.
      Debug::WriteLineIf( generalSwitch->TraceError, 
         " Please use a different category." );
      #endif
   }

// Class-level declaration.
// Create a TraceSwitch.
static TraceSwitch generalSwitch = new TraceSwitch("General", "Entire Application");

static public void MyErrorMethod(Object myObject, string category)
{
    // Write the message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, myObject.ToString() +
       " is not a valid object for category: ", category);

    // Write a second message if the TraceSwitch level is set to Error or higher.
    Debug.WriteLineIf(generalSwitch.TraceError, " Please use a different category.");
}

' Class-level declaration.
' Create a TraceSwitch.
Private Shared generalSwitch As New TraceSwitch("General", "Entire Application")


Public Shared Sub MyErrorMethod(myObject As Object, category As String)
    ' Write the message if the TraceSwitch level is set to Verbose.
    Debug.WriteIf(generalSwitch.TraceVerbose, myObject.ToString() & _
        " is not a valid object for category: ", category)
    
    ' Write a second message if the TraceSwitch level is set to Error or higher.
    Debug.WriteLineIf(generalSwitch.TraceError, " Please use a different category.")
End Sub

Remarks

By default, the output is written to an instance of DefaultTraceListener.

The category parameter can be used to group output messages.

This method calls the TraceListener.Write method of the trace listener.

Notes to Inheritors

First example:

if(mySwitch.TraceError)
    Debug.Write("aNumber = " + aNumber + " out of range");

Second example:

Debug.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

Applies to

Deila með

Debug.WriteIf Method

Definition

Overloads

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler)

Parameters

Remarks

See also

Applies to

WriteIf(Boolean, Object)

Parameters

Examples

Remarks

Notes to Inheritors

See also

Applies to

WriteIf(Boolean, String)

Parameters

Examples

Remarks

Notes to Inheritors

See also

Applies to

WriteIf(Boolean, Debug+WriteIfInterpolatedStringHandler, String)

Parameters

Remarks

See also

Applies to

WriteIf(Boolean, Object, String)

Parameters

Examples

Remarks

Notes to Inheritors

See also

Applies to

WriteIf(Boolean, String, String)

Parameters

Examples

Remarks

Notes to Inheritors

See also

Applies to

Fleiri tilföng