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

LBound 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 smallest 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

LBound(arrayname [, dimension ] )

The LBound 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 lower 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 LBound function is used with the UBound function to determine the size of an array. Use the UBound function to find the upper limit of an array dimension.

LBound returns the values in the following table for an array with the following dimensions:

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

      
Statement Return Value
LBound(A, 1) 1
LBound(A, 2) 0
LBound(A, 3) -3

The default lower bound for any dimension is either 0 or 1, depending on the setting of the Option Base statement. The base of an array created with the Array function is zero; it is unaffected by Option Base.

Arrays for which dimensions are set using the To clause in a Dim, Private, Public, ReDim, or Static statement can have any integer value as a lower bound.

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 LBound function to determine the smallest available subscript for the indicated dimension of an array. Use the Option Base statement to override the default base array subscript value of 0.

Dim Lower
' Declare array variables.
Dim MyArray(1 To 10, 5 To 15, 10 To 20)     
Dim AnyArray(10)
Lower = MyArray 1     ' Returns 1.
Lower = MyArray 3    ' Returns 10.
Lower = AnyArray
' Returns 0 or 1, depending on setting of Option Base.