Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Debug.WriteLineIf Method (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.

Namespace: System.Diagnostics
Assembly: System (in system.dll)

[ConditionalAttribute("DEBUG")] 
public static void WriteLineIf (
	bool condition,
	Object value,
	string category
)
/** @attribute ConditionalAttribute("DEBUG") */ 
public static void WriteLineIf (
	boolean condition, 
	Object value, 
	String category
)
ConditionalAttribute("DEBUG") 
public static function WriteLineIf (
	condition : boolean, 
	value : Object, 
	category : String
)

Parameters

condition

true to cause a message to be written; otherwise, false.

value

An object whose name is sent to the Listeners.

category

A category name used to organize the output.

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 WriteLine method of the trace listener.

Notes to Implementers You can minimize the performance penalty of instrumenting your application by using If...Then statements instead of using WriteLineIf 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 WriteLine. The second example always calls WriteLineIf, 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.WriteLine("aNumber = " + aNumber + " out of range");
Second example.
 Debug.WriteLineIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

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

If the switch is set to the TraceLevelError or higher, 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 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 = new TraceSwitch("General", "Entire Application");

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

   // Write a second message if the TraceSwitch level is set to Verbose.
   Debug.WriteLineIf(generalSwitch.TraceVerbose, myObject, category);
}


// Class-level declaration.
// Create a TraceSwitch.
private static TraceSwitch generalSwitch = 
    new 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.
    Debug.WriteIf(generalSwitch.get_TraceError(), 
        "Invalid object for category. ");

    // Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteLineIf(generalSwitch.get_TraceVerbose(), myObject, category);
} //MyErrorMethod

// Class level declaration.
 // Create a TraceSwitch.
 static var generalSwitch : TraceSwitch = new TraceSwitch("General", "Entire Application");
 
 static public function MyErrorMethod(myObject : Object, category : String) {
    // Write the message if the TraceSwitch level is set to Error or higher.
    Debug.WriteIf(generalSwitch.TraceError, "Invalid object for category. ");
 
    //Write a second message if the TraceSwitch level is set to Verbose.
    Debug.WriteLineIf(generalSwitch.TraceVerbose, myObject, category);
 }


Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft