Share via


CollectionAssert.AreEqual Method (ICollection, ICollection, IComparer)

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.

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 _
)
public static void AreEqual(
    ICollection expected,
    ICollection actual,
    IComparer comparer
)
public:
static void AreEqual(
    ICollection^ expected, 
    ICollection^ actual, 
    IComparer^ comparer
)
static member AreEqual : 
        expected:ICollection * 
        actual:ICollection * 
        comparer:IComparer -> unit
public static function AreEqual(
    expected : ICollection, 
    actual : ICollection, 
    comparer : IComparer
)

Parameters

  • expected
    Type: ICollection

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

  • actual
    Type: ICollection

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

  • comparer
    Type: IComparer

    The compare implementation to use when comparing elements of the collection.

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