Duration (Pacific Standard Time):
To (Pacific Standard Time):
Impact:
User Action:
.NET Framework Class Library

String.EndsWith Method (String, StringComparison)

Determines whether the end of this string instance matches the specified string when compared using the specified comparison option.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
<ComVisibleAttribute(False)> _
Public Function EndsWith ( _
	value As String, _
	comparisonType As StringComparison _
) As Boolean

Parameters

value
Type: System.String

The string to compare to the substring at the end of this instance.

comparisonType
Type: System.StringComparison

One of the enumeration values that determines how this string and value are compared.

Return Value

Type: System.Boolean
true if the value parameter matches the end of this string; otherwise, false.
Exception Condition
ArgumentNullException

value is null.

ArgumentException

comparisonType is not a StringComparison value.

The EndsWith method compares the value parameter to the substring at the end of this string and returns a value that indicates whether they are equal. To be equal, value must be a reference to this same string, must be the empty string (""), or must match the end of this string. The type of comparison performed by the EndsWith method depends on the value of the comparisonType parameter.

The following example determines whether a string ends with a particular substring. The results are affected by the choice of culture, whether case is ignored, and whether an ordinal comparison is performed.

' This example demonstrates the  
' System.String.EndsWith(String, StringComparison) method. 

Imports System
Imports System.Threading

Class Sample
    Public Shared Sub Main() 
        Dim intro As String = "Determine whether a string ends with another string, " & _
                              "using" & vbCrLf & "  different values of StringComparison." 

        Dim scValues As StringComparison() =  { _
                        StringComparison.CurrentCulture, _
                        StringComparison.CurrentCultureIgnoreCase, _
                        StringComparison.InvariantCulture, _
                        StringComparison.InvariantCultureIgnoreCase, _
                        StringComparison.Ordinal, _
                        StringComparison.OrdinalIgnoreCase }
        '
        Console.Clear()
        Console.WriteLine(intro)

        ' Display the current culture because the culture-specific comparisons 
        ' can produce different results with different cultures.
        Console.WriteLine("The current culture is {0}." & vbCrLf, _
                           Thread.CurrentThread.CurrentCulture.Name)

        ' Determine whether three versions of the letter I are equal to each other.  
        Dim sc As StringComparison
        For Each sc In  scValues
            Console.WriteLine("StringComparison.{0}:", sc)
            Test("abcXYZ", "XYZ", sc)
            Test("abcXYZ", "xyz", sc)
            Console.WriteLine()
        Next sc

    End Sub 'Main


    Protected Shared Sub Test(ByVal x As String, ByVal y As String, _
                              ByVal comparison As StringComparison) 
        Dim resultFmt As String = """{0}"" {1} with ""{2}""." 
        Dim result As String = "does not end" 
        
        If x.EndsWith(y, comparison) Then
            result = "ends" 
        End If
        Console.WriteLine(resultFmt, x, result, y)

    End Sub 'Test
End Class 'Sample


'This code example produces the following results: 

'Determine whether a string ends with another string, using 
'  different values of StringComparison. 
'The current culture is en-US. 

'StringComparison.CurrentCulture: 
'"abcXYZ" ends with "XYZ". 
'"abcXYZ" does not end with "xyz". 

'StringComparison.CurrentCultureIgnoreCase: 
'"abcXYZ" ends with "XYZ". 
'"abcXYZ" ends with "xyz". 

'StringComparison.InvariantCulture: 
'"abcXYZ" ends with "XYZ". 
'"abcXYZ" does not end with "xyz". 

'StringComparison.InvariantCultureIgnoreCase: 
'"abcXYZ" ends with "XYZ". 
'"abcXYZ" ends with "xyz". 

'StringComparison.Ordinal: 
'"abcXYZ" ends with "XYZ". 
'"abcXYZ" does not end with "xyz". 

'StringComparison.OrdinalIgnoreCase: 
'"abcXYZ" ends with "XYZ". 
'"abcXYZ" ends with "xyz". 
'

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.