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

Verifies that two specified strings are equal, ignoring case or not as specified. The assertion fails if they 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 String, _
    actual As String, _
    ignoreCase As Boolean, _
    message As String, _
    ParamArray parameters As Object() _
)
public static void AreEqual(
    string expected,
    string actual,
    bool ignoreCase,
    string message,
    params Object[] parameters
)
public:
static void AreEqual(
    String^ expected, 
    String^ actual, 
    bool ignoreCase, 
    String^ message, 
    ... array<Object^>^ parameters
)
static member AreEqual : 
        expected:string * 
        actual:string * 
        ignoreCase:bool * 
        message:string * 
        parameters:Object[] -> unit
public static function AreEqual(
    expected : String, 
    actual : String, 
    ignoreCase : boolean, 
    message : String, 
    ... parameters : Object[]
)

Parameters

  • expected
    Type: String

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

  • actual
    Type: String

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

  • ignoreCase
    Type: Boolean

    A Boolean value that indicates a case-sensitive or insensitive comparison. true indicates a case-insensitive comparison.

  • 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

The invariant culture is used for the comparison.

.NET Framework Security

See Also

Reference

Assert Class

AreEqual Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace

Other Resources

Using the Assert Classes