Team Test API
Assert..::.AreEqual Method (Object, Object, String)

Verifies that two specified objects are equal. The assertion fails if the objects are not equal. Displays a message if the assertion fails.

Namespace:  Microsoft.VisualStudio.TestTools.UnitTesting
Assembly:  Microsoft.VisualStudio.QualityTools.UnitTestFramework (in Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll)
Syntax

Visual Basic (Declaration)
Public Shared Sub AreEqual ( _
    expected As Object, _
    actual As Object, _
    message As String _
)
Visual Basic (Usage)
Dim expected As Object
Dim actual As Object
Dim message As String

Assert.AreEqual(expected, actual, message)
C#
public static void AreEqual(
    Object expected,
    Object actual,
    string message
)
Visual C++
public:
static void AreEqual(
    Object^ expected, 
    Object^ actual, 
    String^ message
)
JScript
public static function AreEqual(
    expected : Object, 
    actual : Object, 
    message : String
)

Parameters

expected
Type: System..::.Object
The first object to compare. This is the object the unit test expects.
actual
Type: System..::.Object
The second object to compare. This is the object the unit test produced.
message
Type: System..::.String
A message to display if the assertion fails. This message can be seen in the unit test results.
Exceptions

ExceptionCondition
AssertFailedException

expected is not equal to actual.

Remarks

Different numeric types are treated as equal if the logical values are equal. For example, 42L is equal to 42.

Permissions

See Also

Reference

Other Resources

Page view tracker