Information.LBound Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Returns the lowest available subscript for the indicated dimension of an array.
Namespace: Microsoft.VisualBasic
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)
Syntax
'Declaration
Public Shared Function LBound ( _
Array As Array, _
Rank As Integer _
) As Integer
public static int LBound(
Array Array,
int Rank
)
Parameters
- Array
Type: System.Array
Required. Array of any data type. The array in which you want to find the lowest possible subscript of a dimension.
- Rank
Type: System.Int32
Optional. Integer. The dimension for which the lowest possible subscript is to be returned. Use 1 for the first dimension, 2 for the second, and so on. If Rank is omitted, 1 is assumed.
Return Value
Type: System.Int32
Integer . The lowest value the subscript for the specified dimension can contain. LBound always returns 0 as long as Array has been initialized, even if it has no elements, for example if it is a zero-length string. If Array is Nothing, LBound throws an ArgumentNullException.
Remarks
Since array subscripts start at 0, the lowest available subscript for every dimension is always 0.
For an array with the following dimensions, LBound returns the values in the following table:
Dim a(100, 5, 4) As Byte
Call to LBound |
Return value |
|---|---|
LBound(a, 1) |
0 |
LBound(a, 2) |
0 |
LBound(a, 3) |
0 |
Examples
The following example uses the LBound function to determine the lowest available subscript for the indicated dimension of an array.
Dim lowest, bigArray(10, 15, 20), littleArray(6) As Integer
lowest = LBound(bigArray, 1)
lowest = LBound(bigArray, 3)
lowest = LBound(littleArray)
' All three calls to LBound return 0.
Version Information
Silverlight
Supported in: 5, 4, 3
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also