1 out of 2 rated this helpful - Rate this topic

String.LastIndexOf Method (String, StringComparison)

Reports the index of the last occurrence of a specified string within the current String object. A parameter specifies the type of search to use for the specified string.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
'Declaration
Public Function LastIndexOf ( _
	value As String, _
	comparisonType As StringComparison _
) As Integer
'Usage
Dim instance As String 
Dim value As String 
Dim comparisonType As StringComparison 
Dim returnValue As Integer 

returnValue = instance.LastIndexOf(value, _
	comparisonType)

Parameters

value
Type: System.String

The String object to seek.

comparisonType
Type: System.StringComparison

One of the System.StringComparison values.

Return Value

Type: System.Int32
The index position of the value parameter if that string is found, or -1 if it is not. If value is Empty, the return value is the last index position in this instance.
ExceptionCondition
ArgumentNullException

value is Nothing.

ArgumentException

comparisonType is not a valid System.StringComparison value.

Index numbering starts from zero. That is, the first character in the string is at index zero and the last is at Length - 1.

The comparisonType parameter specifies to search for the value parameter using the current or invariant culture, using a case-sensitive or case-insensitive search, and using word or ordinal comparison rules.

The search begins at the last character position of this instance and proceeds backward toward the beginning until either value is found or the first character position has been examined.

The following example demonstrates three overloads of the LastIndexOf method that find the last occurrence of a string within another string using different values of the StringComparison enumeration.

' This code example demonstrates the  
' System.String.LastIndexOf(String, ..., StringComparison) methods. 

Imports System
Imports System.Threading
Imports System.Globalization

Class Sample
    Public Shared Sub Main() 
        Dim intro As String = "Find the last occurrence of a character using different " & _
                              "values of StringComparison." 
        Dim resultFmt As String = "Comparison: {0,-28} Location: {1,3}" 

        ' Define a string to search for. 
        ' U+00c5 = LATIN CAPITAL LETTER A WITH RING ABOVE 
        Dim CapitalAWithRing As String = "Å" 

        ' Define a string to search.  
        ' The result of combining the characters LATIN SMALL LETTER A and COMBINING  
        ' RING ABOVE (U+0061, U+030a) is linguistically equivalent to the character  
        ' LATIN SMALL LETTER A WITH RING ABOVE (U+00e5). 
        Dim cat As String = "A Cheshire c" & "å" & "t" 
        Dim loc As Integer = 0
        Dim scValues As StringComparison() =  { _
                        StringComparison.CurrentCulture, _
                        StringComparison.CurrentCultureIgnoreCase, _
                        StringComparison.InvariantCulture, _
                        StringComparison.InvariantCultureIgnoreCase, _
                        StringComparison.Ordinal, _
                        StringComparison.OrdinalIgnoreCase }
        Dim sc As StringComparison

        ' Clear the screen and display an introduction.
        Console.Clear()
        Console.WriteLine(intro)

        ' Display the current culture because culture affects the result. For example,  
        ' try this code example with the "sv-SE" (Swedish-Sweden) culture.
        Thread.CurrentThread.CurrentCulture = New CultureInfo("en-US")
        Console.WriteLine("The current culture is ""{0}"" - {1}.", _
                           Thread.CurrentThread.CurrentCulture.Name, _
                           Thread.CurrentThread.CurrentCulture.DisplayName)

        ' Display the string to search for and the string to search.
        Console.WriteLine("Search for the string ""{0}"" in the string ""{1}""", _
                           CapitalAWithRing, cat)
        Console.WriteLine()

        ' Note that in each of the following searches, we look for  
        ' LATIN CAPITAL LETTER A WITH RING ABOVE in a string that contains  
        ' LATIN SMALL LETTER A WITH RING ABOVE. A result value of -1 indicates  
        ' the string was not found. 
        ' Search using different values of StringComparsion. Specify the start  
        ' index and count. 
        Console.WriteLine("Part 1: Start index and count are specified.")
        For Each sc In  scValues
            loc = cat.LastIndexOf(CapitalAWithRing, cat.Length - 1, cat.Length, sc)
            Console.WriteLine(resultFmt, sc, loc)
        Next sc

        ' Search using different values of StringComparsion. Specify the  
        ' start index. 
        Console.WriteLine(vbCrLf & "Part 2: Start index is specified.")
        For Each sc In  scValues
            loc = cat.LastIndexOf(CapitalAWithRing, cat.Length - 1, sc)
            Console.WriteLine(resultFmt, sc, loc)
        Next sc

        ' Search using different values of StringComparsion. 
        Console.WriteLine(vbCrLf & "Part 3: Neither start index nor count is specified.")
        For Each sc In  scValues
            loc = cat.LastIndexOf(CapitalAWithRing, sc)
            Console.WriteLine(resultFmt, sc, loc)
        Next sc

    End Sub 'Main
End Class 'Sample


'Note: This code example was executed on a console whose user interface  
'culture is "en-US" (English-United States). 

'This code example produces the following results: 

'Find the last occurrence of a character using different values of StringComparison. 
'The current culture is "en-US" - English (United States). 
'Search for the string "Å" in the string "A Cheshire ca°t" 

'Part 1: Start index and count are specified. 
'Comparison: CurrentCulture               Location:  -1 
'Comparison: CurrentCultureIgnoreCase     Location:  12 
'Comparison: InvariantCulture             Location:  -1 
'Comparison: InvariantCultureIgnoreCase   Location:  12 
'Comparison: Ordinal                      Location:  -1 
'Comparison: OrdinalIgnoreCase            Location:  -1 

'Part 2: Start index is specified. 
'Comparison: CurrentCulture               Location:  -1 
'Comparison: CurrentCultureIgnoreCase     Location:  12 
'Comparison: InvariantCulture             Location:  -1 
'Comparison: InvariantCultureIgnoreCase   Location:  12 
'Comparison: Ordinal                      Location:  -1 
'Comparison: OrdinalIgnoreCase            Location:  -1 

'Part 3: Neither start index nor count is specified. 
'Comparison: CurrentCulture               Location:  -1 
'Comparison: CurrentCultureIgnoreCase     Location:  12 
'Comparison: InvariantCulture             Location:  -1 
'Comparison: InvariantCultureIgnoreCase   Location:  12 
'Comparison: Ordinal                      Location:  -1 
'Comparison: OrdinalIgnoreCase            Location:  -1 
'

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.