Type.GetArrayRank Method

Gets the number of dimensions in an Array.

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

Syntax

'Declaration
Public Overridable Function GetArrayRank As Integer
public virtual int GetArrayRank()

Return Value

Type: System.Int32
An Int32 containing the number of dimensions in the current Type.

Exceptions

Exception Condition
NotSupportedException

The functionality of this method is unsupported in the base class and must be implemented in a derived class instead.

ArgumentException

The current Type is not an array.

Examples

The following example displays the number of dimensions in an array.

Class Example

    Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)

        Dim myArray(,,) As Integer = {{{12,  2,  35}, {300, 78, 33}}, _
                                       {{92, 42, 135}, { 30,  7,  3}}}
        Dim myType As Type = myArray.GetType()

        outputBlock.Text += String.Format("myArray has {0} dimensions." & vbCrLf, _
            myType.GetArrayRank()) 
    End Sub 
End Class 

' This code example produces the following output:
'
'myArray has 3 dimensions.
using System;

class Example
{
    public static void Demo(System.Windows.Controls.TextBlock outputBlock)
    {
        int[,,] myArray = { { { 12,  2,  35 }, { 300, 78, 33 } }, 
                            { { 92, 42, 135 }, {  30,  7,  3 } } };
        Type myType = myArray.GetType();

        outputBlock.Text += String.Format("myArray has {0} dimensions.\n", 
            myType.GetArrayRank());
    }
}

/* This example produces the following output:

myArray has 3 dimensions.
 */

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference