Search all of Office.com
 
Support / Access / Access 2007 Help and How-to / Macros and programmability / Functions (alphabetical)
 
 

UBound Function

Applies to: Microsoft Office Access 2007

 

Returns a Long (Long data type: A fundamental data type that holds large integers. A Long variable is stored as a 32-bit number ranging in value from -2,147,483,648 to 2,147,483,647.) containing the largest available subscript for the indicated dimension of an array (array: A variable that contains a finite number of elements that have a common name and data type. Each element of an array is identified by a unique index number. Changes made to one element of an array don't affect the other elements.).

Syntax

UBound(arrayname [, dimension ] )

The UBound function syntax has these arguments:

Argument Description
arrayname Required. Name of the array variable (variable: A named storage location capable of containing data that can be modified during program execution. Each variable has a name that uniquely identifies it within its level of scope. A data type can be specified or not.); follows standard variable naming conventions.
dimension Optional. Variant (Long). Whole number indicating which dimension's upper bound is returned. Use 1 for the first dimension, 2 for the second, and so on. If dimension is omitted, 1 is assumed.

Remarks

The UBound function is used with the LBound function to determine the size of an array. Use the LBound function to find the lower limit of an array dimension.

UBound returns the following values for an array with these dimensions:

Dim A(1 To 100, 0 To 3, -3 To 4)

      
Statement Return Value
UBound(A, 1) 100
UBound(A, 2) 3
UBound(A, 3) 4

Example

 Note   Examples that follow demonstrate the use of this function in a Visual Basic for Applications (VBA) module. For more information about working with VBA, select Developer Reference in the drop-down list next to Search and enter one or more terms in the search box.

This example uses the UBound function to determine the largest available subscript for the indicated dimension of an array.

Dim Upper
' Declare array variables.
Dim MyArray(1 To 10, 5 To 15, 10 To 20)
Dim AnyArray(10)
Upper = MyArray 1    ' Returns 10.
Upper = MyArray 3    ' Returns 20.
Upper = AnyArray    ' Returns 10.