IndexOf
Description
The IndexOf() method method returns the first index at which a given element can be found in the array, or -9999 if it is not present.
Syntax
expression.IndexOf(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. 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 enumeration. Default is CT_EQUALITY.
Returns
- Type
Long- Description
- The first index of the element in the array; -9999 if not found.
Example
Public Sub IndexOfExample()
Dim result As Long
Dim MyArray As BetterArray
Set MyArray = New BetterArray
MyArray.Push "Banana", "Orange", "Apple", "Mango"
result = MyArray.IndexOf("Apple")
' expected output:
' result = 2
End Sub