Array_regexIndexOf

 Homepage Containers

Searches for the first occurrence, starting with startIndex, for which the specified function's return matches compareRegEx, and returns the index for this element.

foundAt := Array_regexIndexOf(ArrayObject, compareRegEx, startIndex = 1, useFunction = "getValue")

Parameters

ArrayObject The Array object to use for the current operation.
compareRegEx The regular expression to test against.
startIndex The index to start searching from. If omitted, the search starts with the first item.
useFunction

Function whose return is compared. The actual function called is %ClassName%_%useFunction%, with ClassName the class name for the current iteration's object.

If useFunction is the empty string, no function is called, and the object itself is compared.

Return Value

The index for the first matching element, starting with startIndex.

If there is no such element, the function returns 0.


The function's return can be used as a quasi-boolean value; the statement if Array_regexIndexOf(...) would be true if an element is found, and false otherwise.

Remarks

If ArrayObject is NULL (0 or blank), the empty string is returned, to indicate an error.

If an element is unset and useFunction is not the empty string, it will be skipped during the search.

Index values start at 1 and "wrap".

Related

Array_regexLastIndexOf, Array_indexOf, Array_SindexOf

Array_regexFindMatch, Array_regexFindLastMatch

Array_findObject, Array_firstUnset

Array

Examples

;Creates a new Array (of length 10).
myArray := Array_new(10)

;Creates some String objects
aString1 := String_new("Value1")
aString2 := String_new("Value2")
aString3 := String_new("Value1")

;Adds the Strings to myArray
Array_set(myArray, 1, aString1)
Array_set(myArray, 2, aString2)
Array_set(myArray, 3, aString3)

;Searches for "i)value\d" (uses the default function, "getValue").
compareRegEx := "i)value\d"

if foundAt := Array_regexIndexOf(myArray, compareRegEx, 2)
{
    ;foundAt contains the index for the element.
    MsgBox, % """" . compareRegEx . """ is found at index " foundAt "."
}
else
{
    ;foundAt = 0 (i.e. not found)
    MsgBox, % "Search value was not found."
}

Homepage  |  Containers