Export (0) Print
Expand All

Array::GetUpperBound Method

Gets the upper bound of the specified dimension in the Array.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public:
int GetUpperBound(
	int dimension
)

Parameters

dimension
Type: System::Int32

A zero-based dimension of the Array whose upper bound needs to be determined.

Return Value

Type: System::Int32
The upper bound of the specified dimension in the Array.

ExceptionCondition
IndexOutOfRangeException

dimension is less than zero.

-or-

dimension is equal to or greater than Rank.

GetUpperBound(0) returns the upper bound for the indexes of the first dimension of the Array, and GetUpperBound(Rank - 1) returns the upper bound of the last dimension of the Array.

The GetUpperBound method is not affected by the number of elements in the array if the array is empty. The value of the Length property can never be greater than the number of elements allowed, as determined by the upper bound. For example, an array with an upper bound of 10 elements can never have a length greater than 9 (0 represents the first element).

This method is an O(1) operation.

The following code example uses GetLowerBound and GetUpperBound to initialize a one-dimensional array and a multidimensional array.

using namespace System;
void PrintValues( Array^ myArr );
void main()
{
   // Creates a new one-dimensional Array instance of type Int32.
   Array^ my1DIntArray = Array::CreateInstance( Int32::typeid, 5 );

   // Uses GetLowerBound and GetUpperBound in the for loop. 
   for ( int i = my1DIntArray->GetLowerBound( 0 ); i <= my1DIntArray->GetUpperBound( 0 ); i++ )
      my1DIntArray->SetValue( i + 1, i );

   // Displays the bounds and values of the one-dimensional Array.
   Console::WriteLine(  "One-dimensional Array:" );
   Console::WriteLine(  "Rank\tLower\tUpper" );
   Console::WriteLine(  "{0}\t{1}\t{2}", nullptr, my1DIntArray->GetLowerBound( 0 ), my1DIntArray->GetUpperBound( 0 ) );
   Console::WriteLine(  "Values:" );
   PrintValues( my1DIntArray );
   Console::WriteLine();

   // Creates a new three-dimensional Array instance of type Int32.
   Array^ my3DIntArray = Array::CreateInstance( Int32::typeid, 2, 3, 4 );

   // Uses GetLowerBound and GetUpperBound in the for loop. 
   for ( int i = my3DIntArray->GetLowerBound( 0 ); i <= my3DIntArray->GetUpperBound( 0 ); i++ )
      for ( int j = my3DIntArray->GetLowerBound( 1 ); j <= my3DIntArray->GetUpperBound( 1 ); j++ )
         for ( int k = my3DIntArray->GetLowerBound( 2 ); k <= my3DIntArray->GetUpperBound( 2 ); k++ )
         {
            my3DIntArray->SetValue( (i * 100) + (j * 10) + k, i, j, k );
         }

   // Displays the bounds and values of the multidimensional Array.
   Console::WriteLine(  "Multidimensional Array:" );
   Console::WriteLine(  "Rank\tLower\tUpper" );
   for ( int i = 0; i < my3DIntArray->Rank; i++ )
      Console::WriteLine(  "{0}\t{1}\t{2}", i, my3DIntArray->GetLowerBound( i ), my3DIntArray->GetUpperBound( i ) );
   Console::WriteLine(  "Values:" );
   PrintValues( my3DIntArray );
}

void PrintValues( Array^ myArr )
{
   System::Collections::IEnumerator^ myEnumerator = myArr->GetEnumerator();
   int i = 0;
   int cols = myArr->GetLength( myArr->Rank - 1 );
   while ( myEnumerator->MoveNext() )
   {
      if ( i < cols )
      {
         i++;
      }
      else
      {
         Console::WriteLine();
         i = 1;
      }

      Console::Write(  "\t{0}", myEnumerator->Current );
   }

   Console::WriteLine();
}

/*
 This code produces the following output.

One-dimensional Array:
Rank    Lower   Upper
0       0       4
Values:
        1       2       3       4       5

Multidimensional Array:
Rank    Lower   Upper
0       0       1
1       0       2
2       0       3
Values:
        0       1       2       3
        10      11      12      13
        20      21      22      23
        100     101     102     103
        110     111     112     113
        120     121     122     123
*/

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft