StringAssert.StartsWith Method

Definition

Namespace:

Microsoft.VisualStudio.TestTools.UnitTesting

Assembly:

Microsoft.VisualStudio.TestPlatform.TestFramework.dll

Package:

MSTest.TestFramework v3.7.0

Overloads

StartsWith(String, String)	Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.
StartsWith(String, String, String)	Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.
StartsWith(String, String, StringComparison)	Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.
StartsWith(String, String, String, Object[])	Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.
StartsWith(String, String, String, StringComparison)	Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.
StartsWith(String, String, String, StringComparison, Object[])	Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.

StartsWith(String, String)

Source:

StringAssert.cs

Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.

public static void StartsWith (string? value, string? substring);

static member StartsWith : string * string -> unit

Public Shared Sub StartsWith (value As String, substring As String)

Parameters

value

String

The string that is expected to begin with substring.

substring

String

The string expected to be a prefix of value.

Exceptions

AssertFailedException

value is null, or substring is null, or value does not start with substring.

StartsWith(String, String, String)

Source:

StringAssert.cs

Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.

public static void StartsWith (string? value, string? substring, string? message);

static member StartsWith : string * string * string -> unit

Public Shared Sub StartsWith (value As String, substring As String, message As String)

Parameters

value

String

The string that is expected to begin with substring.

substring

String

The string expected to be a prefix of value.

message

String

The message to include in the exception when value does not begin with substring. The message is shown in test results.

Exceptions

AssertFailedException

value is null, or substring is null, or value does not start with substring.

StartsWith(String, String, StringComparison)

Source:

StringAssert.cs

Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.

public static void StartsWith (string? value, string? substring, StringComparison comparisonType);

static member StartsWith : string * string * StringComparison -> unit

Public Shared Sub StartsWith (value As String, substring As String, comparisonType As StringComparison)

Parameters

value

String

The string that is expected to begin with substring.

substring

String

The string expected to be a prefix of value.

comparisonType

StringComparison

The comparison method to compare strings comparisonType.

Exceptions

AssertFailedException

value is null, or substring is null, or value does not start with substring.

StartsWith(String, String, String, Object[])

Source:

StringAssert.cs

Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.

public static void StartsWith (string? value, string? substring, string? message, params object?[]? parameters);

static member StartsWith : string * string * string * obj[] -> unit

Public Shared Sub StartsWith (value As String, substring As String, message As String, ParamArray parameters As Object())

Parameters

value

String

The string that is expected to begin with substring.

substring

String

The string expected to be a prefix of value.

message

String

The message to include in the exception when value does not begin with substring. The message is shown in test results.

parameters

Object[]

An array of parameters to use when formatting message.

Exceptions

AssertFailedException

value is null, or substring is null, or value does not start with substring.

StartsWith(String, String, String, StringComparison)

Source:

StringAssert.cs

Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.

public static void StartsWith (string? value, string? substring, string? message, StringComparison comparisonType);

static member StartsWith : string * string * string * StringComparison -> unit

Public Shared Sub StartsWith (value As String, substring As String, message As String, comparisonType As StringComparison)

Parameters

value

String

The string that is expected to begin with substring.

substring

String

The string expected to be a prefix of value.

message

String

The message to include in the exception when value does not begin with substring. The message is shown in test results.

comparisonType

StringComparison

The comparison method to compare strings comparisonType.

Exceptions

AssertFailedException

value is null, or substring is null, or value does not start with substring.

StartsWith(String, String, String, StringComparison, Object[])

Source:

StringAssert.cs

Tests whether the specified string begins with the specified substring and throws an exception if the test string does not start with the substring.

public static void StartsWith (string? value, string? substring, string? message, StringComparison comparisonType, params object?[]? parameters);

static member StartsWith : string * string * string * StringComparison * obj[] -> unit

Public Shared Sub StartsWith (value As String, substring As String, message As String, comparisonType As StringComparison, ParamArray parameters As Object())

Parameters

value

String

The string that is expected to begin with substring.

substring

String

The string expected to be a prefix of value.

message

String

The message to include in the exception when value does not begin with substring. The message is shown in test results.

comparisonType

StringComparison

The comparison method to compare strings comparisonType.

parameters

Object[]

An array of parameters to use when formatting message.

Exceptions

AssertFailedException

value is null, or substring is null, or value does not start with substring.