Share via


CollectionAssert.AreEqual Method (ICollection, ICollection, IComparer, String)

Verifies that two specified collections are equal, using the specified method to compare the values of elements. The assertion fails if the collections 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

'Declaration
Public Shared Sub AreEqual ( _
    expected As ICollection, _
    actual As ICollection, _
    comparer As IComparer, _
    message As String _
)
public static void AreEqual(
    ICollection expected,
    ICollection actual,
    IComparer comparer,
    string message
)
public:
static void AreEqual(
    ICollection^ expected, 
    ICollection^ actual, 
    IComparer^ comparer, 
    String^ message
)
static member AreEqual : 
        expected:ICollection * 
        actual:ICollection * 
        comparer:IComparer * 
        message:string -> unit 
public static function AreEqual(
    expected : ICollection, 
    actual : ICollection, 
    comparer : IComparer, 
    message : String
)

Parameters

  • message
    Type: System.String
    A message to display if the assertion fails. This message can be seen in the unit test results.

Exceptions

Exception Condition
AssertFailedException

expected is not equal to actual.

Remarks

Two collections are equal if they have the same elements in the same order and quantity. Elements are equal if their values are equal, not if they refer to the same object.

.NET Framework Security

See Also

Reference

CollectionAssert Class

AreEqual Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace

Other Resources

Using the Assert Classes