Share via


StringAssert.Contains Method (String, String, String, array<Object )

Verifies that the first string contains the second string. Displays a message if the assertion fails, and applies the specified formatting to it. This method is case sensitive.

Namespace:  Microsoft.VisualStudio.TestTools.UnitTesting
Assembly:  Microsoft.VisualStudio.QualityTools.UnitTestFramework (in Microsoft.VisualStudio.QualityTools.UnitTestFramework.dll)

Syntax

'Declaration
Public Shared Sub Contains ( _
    value As String, _
    substring As String, _
    message As String, _
    ParamArray parameters As Object() _
)
public static void Contains(
    string value,
    string substring,
    string message,
    params Object[] parameters
)
public:
static void Contains(
    String^ value, 
    String^ substring, 
    String^ message, 
    ... array<Object^>^ parameters
)
static member Contains : 
        value:string * 
        substring:string * 
        message:string * 
        parameters:Object[] -> unit
public static function Contains(
    value : String, 
    substring : String, 
    message : String, 
    ... parameters : Object[]
)

Parameters

  • value
    Type: String

    The string that is expected to contain substring.

  • substring
    Type: String

    The string expected to occur within value.

  • 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

substring is not found in value.

Remarks

The assertion fails if the substring does not occur within the string.

.NET Framework Security

See Also

Reference

StringAssert Class

Contains Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace