IndexOf

Description

The LastIndexOf() method method returns the last index at which a given element can be found in the array, or -9999 if it is not present.

Syntax

expression.LastIndexOf(SearchElement,[FromIndex],[CompType])

Parameters

Name: SearchElement
Type: Variant
Necessity: Required
Description: The element to locate in the array.

Name: FromIndex
Type: Long
Necessity: Optional
Description: The index to start the search at. Defaults to the UpperBound of the array. If the index is greater than or equal to the array’s length, -9999 is returned, which means the array will not be searched. If the provided index value is a negative number, it is taken as the offset from the end of the array. Note: if the provided index is negative, the array is still searched from front to back. If the provided index is 0, then the whole array will be searched. Default: entire array is searched.

Name: CompType
Type: ComparisonType (Long)
Necessity: Optional
Description: The type of comparison to perform. See the comparison type enumerations below. Default is CT_EQUALITY.

ComparisonType Enumerations

CT_EQUALITY: Compares SearchElement against the element at the current index for equality. This is the default comparison method.
CT_LIKENESS: SearchElement is treated as a string pattern and compared against the element as the current index using the Like operator. If this option is chosen SearchElement must be a String type or an error will be raised.

Returns

Type: Long
Description: The last index of the element in the array; -9999 if not found.

Example

Public Sub LastIndexOfExample()
    Dim result As Long
    Dim MyArray As BetterArray
    Set MyArray = New BetterArray

    MyArray.Push "Apple", "Banana", "Orange", "Apple", "Mango"
    result = MyArray.LastIndexOf("Apple")
    ' expected output:
    ' result  = 3
End Sub

Inspiration

Back to Docs