LBound 関数 (Visual Basic)

[アーティクル]
09/30/2008

更新 : 2007 年 11 月

配列の指定された次元で使用できる添字の最小値を返します。

Public Function LBound( _
   ByVal Array As System.Array, _
   Optional ByVal Rank As Integer = 1 _
) As Integer

パラメータ

Array
必ず指定します。任意のデータ型の配列です。ある次元で使用できる添字の最小値を調べる対象となる配列を指定します。
Rank
省略可能です。Integer 型の値です。使用できる添字の最小値を取得する次元を指定します。最初の次元なら 1、2 番目の次元なら 2 というように指定します。Rank を省略すると、1 が使用されます。

戻り値

Integer 型の値です。指定された次元に格納できる添字の最小値です。Array が初期化されていれば、要素が長さゼロの文字列であるなど、要素がない場合でも LBound は必ず 0 を返します。Array が Nothing であれば、LBound は ArgumentNullException をスローします。

例外

例外の種類	エラー番号	条件
ArgumentNullException	9	Array が Nothing です。
RankException	9	Rank < 1 です。または、Rank が Array のランクより大きな値です。

非構造化エラー処理を使用する Visual Basic 6.0 アプリケーションをアップグレードする場合は、"エラー番号" の列を参照してください(エラー番号を Number プロパティ (Err オブジェクト) と比較することもできます)。ただし、可能であれば、このようなエラー制御は Visual Basic の構造化例外処理の概要に置き換えることを検討してください。

解説

配列の添字は 0 から始まるため、各次元で使用できる添字の最小値は常に 0 です。

配列の次元と LBound 関数が返す値の関係を次に示します。

Dim a(100, 5, 4) As Byte

LBound の呼び出し	戻り値
LBound(a, 1)	0
LBound(a, 2)	0
LBound(a, 3)	0

使用例

LBound 関数を使って、配列の指定された次元で使用できる添字の最小値を調べるコード例は、次のとおりです。

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.