Type.GetArrayRank Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

Type.cs

Gets the number of dimensions in an array.

public:
 virtual int GetArrayRank();

public virtual int GetArrayRank ();

abstract member GetArrayRank : unit -> int
override this.GetArrayRank : unit -> int

Public Overridable Function GetArrayRank () As Integer

Returns

Int32

An integer that contains the number of dimensions in the current type.

Exceptions

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.

using namespace System;
int main()
{
   try
   {
      array<Int32, 3>^myArray = gcnew array<Int32,3>(3,4,5);
      Type^ myType = myArray->GetType();
      Console::WriteLine( "myArray has {0} dimensions.", myType->GetArrayRank() );
   }
   catch ( NotSupportedException^ e ) 
   {
      Console::WriteLine( "NotSupportedException raised." );
      Console::WriteLine( "Source: {0}", e->Source );
      Console::WriteLine( "Message: {0}", e->Message );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "Exception raised." );
      Console::WriteLine( "Source: {0}", e->Source );
      Console::WriteLine( "Message: {0}", e->Message );
   }

}

using System;

class MyArrayRankSample
{
    public static void Main()
    {
        try
        {
            int[,,] myArray = new int[,,] {{{12,2,35},{300,78,33}},{{92,42,135},{30,7,3}}};
            Type myType = myArray.GetType();

            Console.WriteLine("Contents of myArray: {{{12,2,35},{300,78,33}},{{92,42,135},{30,7,3}}}");
            Console.WriteLine("myArray has {0} dimensions.", myType.GetArrayRank());
        }
        catch(NotSupportedException e)
        {
            Console.WriteLine("NotSupportedException raised.");
            Console.WriteLine("Source: " + e.Source);
            Console.WriteLine("Message: " + e.Message);
        }
        catch(Exception e)
        {
            Console.WriteLine("Exception raised.");
            Console.WriteLine("Source: " + e.Source);
            Console.WriteLine("Message: " + e.Message);
        }
    }
}

open System

try
    let myArray = Array3D.zeroCreate 2 2 3
    myArray[0, 0, 0] <- 12
    myArray[0, 0, 1] <- 2
    myArray[0, 0, 2] <- 35

    myArray[0, 1, 0] <- 300
    myArray[0, 1, 1] <- 78
    myArray[0, 1, 2] <- 33
    
    myArray[1, 0, 0] <- 92
    myArray[1, 0, 1] <- 42
    myArray[1, 0, 2] <- 135
    
    myArray[1, 1, 0] <- 30
    myArray[1, 1, 1] <- 7
    myArray[1, 1, 2] <- 3
    let myType = myArray.GetType()

    printfn "Contents of myArray: {{{12,2,35},{300,78,33}},{{92,42,135},{30,7,3}}}"
    printfn $"myArray has {myType.GetArrayRank()} dimensions."
with 
| :? NotSupportedException as e ->
    printfn "NotSupportedException raised."
    printfn $"Source: {e.Source}"
    printfn $"Message: {e.Message}"
| e ->
    printfn "Exception raised."
    printfn $"Source: {e.Source}"
    printfn $"Message: {e.Message}"

Class MyArrayRankSample
    Public Shared Sub Main()
        Try
            Dim myArray(,,) As Integer = {{{12, 2, 35}, {300, 78, 33}}, {{92, 42, 135}, {30, 7, 3}}}
            Dim myType As Type = myArray.GetType()
            Console.WriteLine("Contents of myArray: {{{12,2,35},{300,78,33}},{{92,42,135},{30,7,3}}}")
            Console.WriteLine("myArray has {0} dimensions.", myType.GetArrayRank())
        Catch e As NotSupportedException
            Console.WriteLine("NotSupportedException raised.")
            Console.WriteLine(("Source: " + e.Source))
            Console.WriteLine(("Message: " + e.Message))
        Catch e As Exception
            Console.WriteLine("Exception raised.")
            Console.WriteLine(("Source: " + e.Source))
            Console.WriteLine(("Message: " + e.Message))
        End Try
    End Sub
End Class

See also

• Array
• Rank