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

Verifies that the first string begins with 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 StartsWith ( _
    value As String, _
    substring As String, _
    message As String, _
    ParamArray parameters As Object() _
)

public static void StartsWith(
    string value,
    string substring,
    string message,
    params Object[] parameters
)

public:
static void StartsWith(
    String^ value, 
    String^ substring, 
    String^ message, 
    ... array<Object^>^ parameters
)

static member StartsWith : 
        value:string * 
        substring:string * 
        message:string * 
        parameters:Object[] -> unit

public static function StartsWith(
    value : String, 
    substring : String, 
    message : String, 
    ... parameters : Object[]
)

Parameters

• value
  Type: String

  The string that is expected to begin with substring.

• substring
  Type: String

  The string expected to be a prefix of 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	value does not begin with substring.

Remarks

The assertion fails if the string does not start with the substring.

.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

StringAssert Class

StartsWith Overload

Microsoft.VisualStudio.TestTools.UnitTesting Namespace