This documentation is archived and is not being maintained.
Array::GetLength Method
Visual Studio 2010
Gets a 32-bit integer that represents the number of elements in the specified dimension of the Array.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- dimension
- Type: System::Int32
A zero-based dimension of the Array whose length needs to be determined.
Return Value
Type: System::Int32A 32-bit integer that represents the number of elements in the specified dimension.
| Exception | Condition |
|---|---|
| IndexOutOfRangeException | dimension is less than zero. -or- dimension is equal to or greater than Rank. |
An example of GetLength is GetLength(0), which returns the number of elements in the first dimension of the Array.
This method is an O(1) operation.
The following example shows how to use GetLength to display the dimensions of two arrays with different ranks.
using namespace System; public ref class SamplesArray { public: static void Main() { // make a single dimension array Array^ MyArray1 = Array::CreateInstance(int::typeid, 5); // make a 3 dimensional array Array^ MyArray2 = Array::CreateInstance(int::typeid, 5, 3, 2); // make an array container Array^ BossArray = Array::CreateInstance(Array::typeid, 2); BossArray->SetValue(MyArray1, 0); BossArray->SetValue(MyArray2, 1); int i = 0, j, rank; for each (Array^ anArray in BossArray) { rank = anArray->Rank; if (rank > 1) { Console::WriteLine("Lengths of {0:d} dimension array[{1:d}]", rank, i); // show the lengths of each dimension for (j = 0; j < rank; j++) { Console::WriteLine(" Length of dimension({0:d}) = {1:d}", j, anArray->GetLength(j)); } } else { Console::WriteLine("Lengths of single dimension array[{0:d}]", i); } // show the total length of the entire array or all dimensions Console::WriteLine(" Total length of the array = {0:d}", anArray->Length); Console::WriteLine(); i++; } } }; int main() { SamplesArray::Main(); } /* This code produces the following output: Lengths of single dimension array[0] Total length of the array = 5 Lengths of 3 dimension array[1] Length of dimension(0) = 5 Length of dimension(1) = 3 Length of dimension(2) = 2 Total length of the array = 30 */
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: