Export (0) Print
Expand All

Trace.WriteIf Method (Boolean, Object)

Writes 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("TRACE")] 
public static void WriteIf (
	bool condition,
	Object value
)
/** @attribute ConditionalAttribute("TRACE") */ 
public static void WriteIf (
	boolean condition, 
	Object value
)
ConditionalAttribute("TRACE") 
public static function WriteIf (
	condition : boolean, 
	value : Object
)

Parameters

condition

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

value

An Object whose name is sent to the Listeners.

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

This method calls the Write 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 WriteIf 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. The second example always calls WriteIf, 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) 
    Trace.Write("aNumber = " + aNumber + " out of range");
Second example
Trace.WriteIf(mySwitch.TraceError, "aNumber = " + aNumber + " out of range");

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

If the switch is set to the TraceLevelError 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. The second message is followed by a line terminator.

// 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.
    Trace.WriteIf(generalSwitch.TraceError, myObject);
 
    // Write a second message if the TraceSwitch level is set to Verbose.
    Trace.WriteLineIf(generalSwitch.TraceVerbose, " is not a valid value for this method.");
 }


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

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

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

// Create a TraceSwitch.
var generalSwitch : TraceSwitch = new TraceSwitch("General", "Entire Application")    

function MyErrorMethod(errorObject : Object){
  // Write a message if the TraceSwitch level is set to Error or higher.
  Trace.WriteIf(generalSwitch.TraceError, errorObject)

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


Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

Community Additions

ADD
Show:
© 2014 Microsoft