Array.GetValue Method (Int32[])

July 28, 2014

Gets the value at the specified position in the multidimensional Array. The indexes are specified as an array of 32-bit integers.

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

public Object GetValue(
	params int[] indices
)

Parameters

indices
Type: System.Int32 []
A one-dimensional array of 32-bit integers that represent the indexes specifying the position of the Array element to get.

Return Value

Type: System.Object
The value at the specified position in the multidimensional Array.

ExceptionCondition
ArgumentNullException

indices is null.

ArgumentException

The number of dimensions in the current Array is not equal to the number of elements in indices.

IndexOutOfRangeException

Any element in indices is outside the range of valid indexes for the corresponding dimension of the current Array.

The number of elements in indices must equal the number of dimensions in the Array. All elements in the indices array must collectively specify the position of the desired element in the multidimensional Array.

The GetLowerBound and GetUpperBound methods can determine whether any of the indexes is out of bounds.

This method is an O(1) operation.

The following code example demonstrates how to set and get a specific value in a one-dimensional or multidimensional array.


using System;

public class Example
{

   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {

      // Creates and initializes a one-dimensional array.
      String[] myArr1 = new String[5];

      // Sets the element at index 3.
      myArr1.SetValue("three", 3);
      outputBlock.Text += String.Format("[3]:   {0}", myArr1.GetValue(3)) + "\n";


      // Creates and initializes a two-dimensional array.
      String[,] myArr2 = new String[5, 5];

      // Sets the element at index 1,3.
      myArr2.SetValue("one-three", 1, 3);
      outputBlock.Text += String.Format("[1,3]:   {0}", myArr2.GetValue(1, 3)) + "\n";


      // Creates and initializes a three-dimensional array.
      String[, ,] myArr3 = new String[5, 5, 5];

      // Sets the element at index 1,2,3.
      myArr3.SetValue("one-two-three", 1, 2, 3);
      outputBlock.Text += String.Format("[1,2,3]:   {0}", myArr3.GetValue(1, 2, 3)) + "\n";


      // Creates and initializes a seven-dimensional array.
      String[, , , , , ,] myArr7 = new String[5, 5, 5, 5, 5, 5, 5];

      // Sets the element at index 1,2,3,0,1,2,3.
      int[] myIndices = new int[7] { 1, 2, 3, 0, 1, 2, 3 };
      myArr7.SetValue("one-two-three-zero-one-two-three", myIndices);
      outputBlock.Text += String.Format("[1,2,3,0,1,2,3]:   {0}", myArr7.GetValue(myIndices)) + "\n";

   }

}


/* 
This code produces the following output.

[3]:   three
[1,3]:   one-three
[1,2,3]:   one-two-three
[1,2,3,0,1,2,3]:   one-two-three-zero-one-two-three

*/



Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2014 Microsoft