Arrays.FirstRowIndex

From Xojo Documentation

Revision as of 06:06, 3 March 2020 by Ktekinay (talk | contribs) (Removed incorrect description, fixed typo.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Method

Arrays.FirstRowIndex() As Integer

Supported for all project types and targets.

Returns the index of the first row of the array.

Usage

result = array.FirstRowIndex

Part Type Description
result Integer The starting index of the array.
array Array of any data type The array whose first element number you want.

Notes

The FirstRowIndex function is used to determine the first element of an array. This is especially useful for writing code that loops through arrays so that you don't have to be aware of whether an array begins at 0 or 1 (they all begin at 0).

Arrays can have a maximum index value of 2,147,483,646.

Sample Code

This code loops through an array and replaces each occurrence of X in an array with Y.

For i As Integer = names.FirstRowIndex To names.LastRowIndex
If names(i) = "X" Then
names(i) = "Y"
End If
Next

See Also

Var statement; Arrays concept, ParamArray keyword, Arrays.LastRowIndex method