Information.UBound メソッド

.NET Framework クラス ライブラリ リファレンス

Information.UBound メソッド

配列内の指定された次元における最も大きいインデックスを返します。

名前空間: Microsoft.VisualBasic
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public Shared Function UBound
 ( _
    Array As Array, _
    <OptionalAttribute> Optional Rank As
 Integer = 1 _
) As Integer

Visual Basic (使用法)

Dim Array As Array
Dim Rank As Integer
Dim returnValue As Integer

returnValue = Information.UBound(Array, Rank)

C#

public static int UBound
 (
    Array Array,
    [OptionalAttribute] int Rank
)

C++

public:
static int UBound (
    Array^ Array, 
    [OptionalAttribute] int Rank
)

J#

public static int UBound
 (
    Array Array, 
    /** @attribute OptionalAttribute() */ int Rank
)

JScript

public static function UBound
 (
    Array : Array, 
    Rank : int
) : int

パラメータ

Array

必須。任意のデータ型の配列です。ある次元で最も大きいインデックスを探す対象となる配列です。

Rank

省略可能。Integer。最も大きいインデックスが返される次元です。1 番目の次元の場合は 1、2 番目の次元の場合は 2 という形で指定します。Rank を省略した場合、1 が使用されます。

戻り値
Integer。指定した次元に設定できるインデックスの最大値です。Array に要素が 1 つしかない場合、UBound は 0 を返します。たとえば長さ 0 の文字列など、Array に要素がない場合、UBound は -1 を返します。

解説

詳細については、Visual Basic のトピック「UBound 関数 (Visual Basic)」を参照してください。

配列のインデックスは 0 から開始されるため、次元の長さはその次元の最大のインデックスよりも 1 だけ大きくなります。

次の次元を持つ配列の場合、UBound は次の表に示す値を返します。

Dim a(100, 5, 4) As Byte

UBound への呼び出し	戻り値
UBound(a, 1)	100
UBound(a, 2)	5
UBound(a, 3)	4

UBound を使用することで、配列内の要素の総数を調べることができますが、インデックスが 0 から開始されることを考慮して、返された値を修正する必要があります。前の例の配列 a の合計サイズを計算する例を次に示します。

Dim total As Integer
total = (UBound(A, 1) + 1) * (UBound(A, 2) + 1) * (UBound(A, 3) + 1)

total の計算結果は 3030 (101 × 6 × 5) になります。

使用例

UBound 関数を使用して、配列内の指定された次元における最も大きいインデックスを判別する例を次に示します。

Visual Basic

Dim highest, bigArray(10, 15, 20), littleArray(6) As
 Integer
highest = UBound(bigArray, 1)
highest = UBound(bigArray, 3)
highest = UBound(littleArray)
' The three calls to UBound return 10, 20, and 6 respectively.

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Information クラス
Information メンバ
Microsoft.VisualBasic 名前空間
ArgumentException
RankException
その他の技術情報
UBound 関数 (Visual Basic)
LBound 関数 (Visual Basic)
Dim ステートメント (Visual Basic)
ReDim ステートメント (Visual Basic)