Export (0) Print
Expand All

String.LastIndexOf Method (String, Int32, Int32)

Reports the zero-based index position of the last occurrence of a specified string within this instance. The search starts at a specified character position and proceeds backward toward the beginning of the string for a specified number of character positions.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Function LastIndexOf ( _
	value As String, _
	startIndex As Integer, _
	count As Integer _
) As Integer

Parameters

value
Type: System.String

The string to seek.

startIndex
Type: System.Int32

The search starting position. The search proceeds from startIndex toward the beginning of this instance.

count
Type: System.Int32

The number of character positions to examine.

Return Value

Type: System.Int32
The zero-based starting index position of value if that string is found, or -1 if it is not found or if the current instance equals String.Empty. If value is Empty, the return value is the smaller of startIndex and the last index position in this instance.

ExceptionCondition
ArgumentNullException

value is Nothing.

ArgumentOutOfRangeException

count is negative.

-or-

The current instance does not equal String.Empty, and startIndex is negative.

-or-

The current instance does not equal String.Empty, and startIndex is greater than the length of this instance.

-or-

The current instance does not equal String.Empty, and startIndex - count + 1 specifies a position that is not within this instance.

-or-

The current instance equals String.Empty and start is less than -1 or greater than zero.

-or-

The current instance equals String.Empty and count is greater than 1.

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 search begins at the startIndex character position of this instance and proceeds backward toward the beginning until either value is found or count character positions have been examined. For example, if startIndex is Length - 1, the method searches backward count characters from the last character in the string.

This method performs a word (case-sensitive and culture-sensitive) search using the current culture.

Character sets include ignorable characters, which are characters that are not considered when performing a linguistic or culture-sensitive comparison. In a culture-sensitive search, if value contains an ignorable character, the result is equivalent to searching with that character removed. If value consists only of one or more ignorable characters, the LastIndexOf method always returns startIndex, which is the character position at which the search begins. In the following example, the LastIndexOf method is used to find the position of a soft hyphen (U+00AD) in the two characters that precede the final "m" of two strings. Only one of the strings contains the required substring. If the example is run on the .NET Framework 4 or later, in both cases, because the soft hyphen is an ignorable character, the method returns the index of "m" in the string when it performs a culture-sensitive comparison. Note that in the case of the first string, which includes the soft hyphen followed by an "m", the method fails to return the index of the soft hyphen but instead returns the index of the "m".

Module Example
   Public Sub Main()
      Dim position As Integer 
      Dim softHyphen As String = ChrW(&h00AD)

      Dim s1 As String = "ani" + softHyphen + "mal" 
      Dim s2 As String = "animal" 

      ' Find the index of the soft hyphen.
      position = s1.LastIndexOf("m")
      Console.WriteLine("'m' at position {0}", position)
      If position >= 0 Then
         Console.WriteLine(s1.LastIndexOf(softHyphen, position, position + 1))
      End If

      position = s2.LastIndexOf("m")
      Console.WriteLine("'m' at position {0}", position)
      If position >= 0 Then
         Console.WriteLine(s2.LastIndexOf(softHyphen, position, position + 1))
      End If 

      ' Find the index of the soft hyphen followed by "n".
      position = s1.LastIndexOf("m")
      Console.WriteLine("'m' at position {0}", position)
      If position >= 0 Then
         Console.WriteLine(s1.LastIndexOf(softHyphen + "n", position, position + 1))
      End If

      position = s2.LastIndexOf("m")
      Console.WriteLine("'m' at position {0}", position)
      If position >= 0 Then
         Console.WriteLine(s2.LastIndexOf(softHyphen + "n", position, position + 1))
      End If 

      ' Find the index of the soft hyphen followed by "m".
      position = s1.LastIndexOf("m")
      Console.WriteLine("'m' at position {0}", position)
      If position >= 0 Then
         Console.WriteLine(s1.LastIndexOf(softHyphen + "m", position, position + 1))
      End If

      position = s2.LastIndexOf("m")
      Console.WriteLine("'m' at position {0}", position)
      If position >= 0 Then
         Console.WriteLine(s2.LastIndexOf(softHyphen + "m", position, position + 1))
      End If 
   End Sub 
End Module 
' The example displays the following output: 
'       'm' at position 4 
'       4 
'       'm' at position 3 
'       3 
'       'm' at position 4 
'       1 
'       'm' at position 3 
'       1 
'       'm' at position 4 
'       4 
'       'm' at position 3 
'       3

Notes to Callers

As explained in Best Practices for Using Strings in the .NET Framework, we recommend that you avoid calling string comparison methods that substitute default values and instead call methods that require parameters to be explicitly specified. To perform this operation by using the comparison rules of the current culture, call the LastIndexOf(String, Int32, Int32, StringComparison) method overload with a value of StringComparison.CurrentCulture for its comparisonType parameter.

The following example finds the index of all occurrences of a string in substring, working from the end of the substring to the start of the substring.

' Sample for String.LastIndexOf(String, Int32, Int32) 
Imports System
 _

Class Sample

   Public Shared Sub Main()

      Dim br1 As String = "0----+----1----+----2----+----3----+----4----+----5----+----6----+-" 
      Dim br2 As String = "0123456789012345678901234567890123456789012345678901234567890123456" 
      Dim str As String = "Now is the time for all good men to come to the aid of their party." 
      Dim start As Integer 
      Dim at As Integer 
      Dim count As Integer 
      Dim [end] As Integer

      start = str.Length - 1
      [end] = start / 2 - 1
      Console.WriteLine("All occurrences of 'he' from position {0} to {1}.", start, [end])
      Console.WriteLine("{1}{0}{2}{0}{3}{0}", Environment.NewLine, br1, br2, str)
      Console.Write("The string 'he' occurs at position(s): ")

      count = 0
      at = 0
      While start > - 1 And at > - 1
         count = start - [end] 'Count must be within the substring.
         at = str.LastIndexOf("he", start, count)
         If at > - 1 Then
            Console.Write("{0} ", at)
            start = at - 1
         End If 
      End While
      Console.Write("{0}{0}{0}", Environment.NewLine)
   End Sub 'Main 
End Class 'Sample

'This example produces the following results: 
'All occurrences of 'he' from position 66 to 32. 
'0----+----1----+----2----+----3----+----4----+----5----+----6----+- 
'0123456789012345678901234567890123456789012345678901234567890123456 
'Now is the time for all good men to come to the aid of their party. 

'The string 'he' occurs at position(s): 56 45 

'

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.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 Silverlight 8.1, Windows Phone Silverlight 8

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.

Show:
© 2014 Microsoft