ArrayGetIndex function (LotusScript® Language)
Searches an array of strings for the value given. If the value is found within the array, the array index of that value is returned.
Syntax
ArrayGetIndex( sourceArray, searchValue [, compMethod ] )
Elements
sourceArray
An array or Variant containing an array.
searchValue
A value to search for within sourceArray.
compMethod
Optional integer specifying the type of comparison to use when searching for searchValue.
| Number |
Comparison Mode |
|---|---|
| 0 |
case sensitive, pitch sensitive |
| 1 |
case insensitive, pitch sensitive |
| 4 |
case sensitive, pitch insensitive |
| 5 |
case insensitive, pitch insensitive |
Return value
A Variant of type long that provides the index into sourceArray where searchValue can be found. If no match is found, NULL is returned.
Usage
ArrayGetIndex converts all values passed to it into strings. For example, if you pass an array of integers, this function converts the values in the array to strings for this operation only. These string values are then used for comparing the array values to the searchValue. Option Compare can be used to specify whether case/pitch sensitivity should play a role in the comparisons. If compMethod is not specified, the default for the module is used.
Items that cannot be converted are not compared.