Share via


StringAssert.Matches Method (String, Regex, String, array<Object )

Verifies that the specified string matches the regular expression. 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 Matches ( _
    value As String, _
    pattern As Regex, _
    message As String, _
    ParamArray parameters As Object() _
)
public static void Matches(
    string value,
    Regex pattern,
    string message,
    params Object[] parameters
)
public:
static void Matches(
    String^ value, 
    Regex^ pattern, 
    String^ message, 
    ... array<Object^>^ parameters
)
static member Matches : 
        value:string * 
        pattern:Regex * 
        message:string * 
        parameters:Object[] -> unit 
public static function Matches(
    value : String, 
    pattern : Regex, 
    message : String, 
    ... parameters : Object[]
)

Parameters

  • value
    Type: System.String
    The string that is expected to match pattern.
  • message
    Type: System.String
    A message to display if the assertion fails. This message can be seen in the unit test results.
  • parameters
    Type: array<System.Object[]
    An array of parameters to use when formatting message.

Exceptions

Exception Condition
AssertFailedException

value does not match pattern.

Remarks

The assertion fails if the string does not match the expression.

.NET Framework Security

See Also

Reference

StringAssert Class

Matches Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace