CollectionAssert.AreEqual Method (ICollection, ICollection, IComparer, String, array<Object )

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, 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 ICollection, _
    actual As ICollection, _
    comparer As IComparer, _
    message As String, _
    ParamArray parameters As Object() _
)

public static void AreEqual(
    ICollection expected,
    ICollection actual,
    IComparer comparer,
    string message,
    params Object[] parameters
)

public:
static void AreEqual(
    ICollection^ expected, 
    ICollection^ actual, 
    IComparer^ comparer, 
    String^ message, 
    ... array<Object^>^ parameters
)

static member AreEqual : 
        expected:ICollection * 
        actual:ICollection * 
        comparer:IComparer * 
        message:string * 
        parameters:Object[] -> unit

public static function AreEqual(
    expected : ICollection, 
    actual : ICollection, 
    comparer : IComparer, 
    message : String, 
    ... parameters : Object[]
)

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.

• 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

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

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CollectionAssert Class

AreEqual Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace

Other Resources

Using the Assert Classes