UBOUND: Difference between revisions

Revision as of 21:24, 2 May 2022

The Template:KW function returns the largest valid index (upper bound) of an array dimension.

result% = Template:KW(arrayName[, dimension%])

dimension% specifies the dimension number, starting with 1 for the first dimension.
- If omitted, dimension% is assumed to be 1.
- If dimension% is less than 1 or is greater than the number of dimensions, a subscript out of range error occurs.

Template:KW, along with Template:KW, is used to determine the range of valid indexes of an array.

DIM myArray(5) AS INTEGER
DIM myOtherArray(1 to 2, 3 to 4) AS INTEGER

PRINT UBOUND(myArray)
PRINT UBOUND(myOtherArray, 2)

 5
 4

@@ Line 9: / Line 9: @@
 * {{Parameter|arrayName}} specifies the name of the array.
-* {{Parameter|dimension%}} specifies the dimension number, starting with <code>1</code> for the first dimension.
+* {{Parameter|dimension%}} specifies the dimension number, starting with '''1''' for the first dimension.
-** If omitted, {{Parameter|dimension%}} is assumed to be <code>1</code>.
+** If omitted, {{Parameter|dimension%}} is assumed to be '''1'''.
-** If {{Parameter|dimension%}} is less than <code>1</code> or is greater than the number of dimensions, a [[ERROR Codes|subscript out of range]] error occurs.
+** If {{Parameter|dimension%}} is less than '''1''' or is greater than the number of dimensions, a [[ERROR Codes|subscript out of range]] error occurs.
 * {{KW|UBOUND}}, along with {{KW|LBOUND}}, is used to determine the range of valid indexes of an array.