Assert.AreEqual Method (Object, Object, String, array<Object )

Verifies that two specified objects are equal. The assertion fails if the objects are not equal. Displays a message if the assertion fails, and applies the specified formatting to it.

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

Syntax

'Declaration
Public Shared Sub AreEqual ( _
    expected As Object, _
    actual As Object, _
    message As String, _
    ParamArray parameters As Object() _
)
public static void AreEqual(
    Object expected,
    Object actual,
    string message,
    params Object[] parameters
)
public:
static void AreEqual(
    Object^ expected, 
    Object^ actual, 
    String^ message, 
    ... array<Object^>^ parameters
)
static member AreEqual : 
        expected:Object * 
        actual:Object * 
        message:string * 
        parameters:Object[] -> unit
public static function AreEqual(
    expected : Object, 
    actual : Object, 
    message : String, 
    ... parameters : Object[]
)

Parameters

  • expected
    Type: Object

    The first object to compare. This is the object the unit test expects.

  • actual
    Type: Object

    The second object to compare. This is the object the unit test produced.

  • message
    Type: String

    A message to display if the assertion fails. This message can be seen in the unit test results.

  • parameters
    Type: array<Object[]

    An array of parameters to use when formatting message.

Exceptions

Exception Condition
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.

.NET Framework Security

See Also

Reference

Assert Class

AreEqual Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace

Other Resources

Using the Assert Classes