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.Assert Method (Boolean)

Checks for a condition and outputs the call stack if the condition is false.

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

[ConditionalAttribute("DEBUG")] 
public static void Assert (
	bool condition
)
/** @attribute ConditionalAttribute("DEBUG") */ 
public static void Assert (
	boolean condition
)
ConditionalAttribute("DEBUG") 
public static function Assert (
	condition : boolean
)
Not applicable.

Parameters

condition

true to prevent a message being displayed; otherwise, false.

Assert outputs the call stack with file and line numbers for each line in the call stack.

Typically, Assert is used to identify logic errors during program development. Assert evaluates the condition. If the result is false, it sends diagnostic messages to the Listeners.

The default behavior displays a message box when the application runs in user-interface mode, and outputs the message to the default trace output. You can customize this behavior by adding a TraceListener to, or removing one from, the Listeners collection.

NoteNote:

The display of the message box is dependent on the presence of the DefaultTraceListener. If the DefaultTraceListener is not in the Listeners collection, the message box is not displayed. The DefaultTraceListener can be removed by the <clear> Element for <listeners> for <trace>, the <remove> Element for <listeners> for <trace>, or by calling the Clear method on the Listeners property (System.Diagnostics.Trace.Listeners.Clear()).

To set an assert, you can also edit the configuration file corresponding to the name of your application. Within this file, you can enable and disable the assert or set the name of its log file. The configuration file should be formatted like the following example:

 <configuration>
     <system.diagnostics>
        <assert assertuienabled="true" logfilename="c:\\myFile.log" />
     </system.diagnostics>
  </configuration>

The following example creates an index for an array. Then some action is performed that sets the value of the index. Next the code calls Assert to confirm the index value is valid. If it is not valid, Assert outputs the call stack.

// Create an index for an array.
 int index;
 
 // Perform some action that sets the index.
 
 // Test that the index value is valid. 
 Debug.Assert(index > -1);   

// Create an index for an array.
int index = 0;
// Test that the index value is valid. 
Debug.Assert(index > -1);

// Create an index for an array.
var index : int;
 
// Perform some action that sets the index.
index = 10;
 
// Test that the index value is valid. 
@if(@DEBUG)
Debug.Assert(index > -1);   
@end

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

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

Community Additions

Show:
© 2014 Microsoft