Array.GetValue Method (Int64, Int64, Int64)

Gets the value at the specified position in the three-dimensional Array. The indexes are specified as 64-bit integers.

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

'Declaration
<ComVisibleAttribute(False)> _
Public Function GetValue ( _
	index1 As Long, _
	index2 As Long, _
	index3 As Long _
) As Object

Parameters

index1
Type: System.Int64

A 64-bit integer that represents the first-dimension index of the Array element to get.

index2
Type: System.Int64

A 64-bit integer that represents the second-dimension index of the Array element to get.

index3
Type: System.Int64

A 64-bit integer that represents the third-dimension index of the Array element to get.

Return Value

Type: System.Object
The value at the specified position in the three-dimensional Array.

ExceptionCondition
ArgumentException

The current Array does not have exactly three dimensions.

ArgumentOutOfRangeException

index1 or index2 or index3 is outside the range of valid indexes for the corresponding dimension of the current 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.

Imports System

Public Class SamplesArray

   Public Shared Sub Main()

      ' Creates and initializes a one-dimensional array. 
      Dim myArr1(4) As [String]

      ' Sets the element at index 3.
      myArr1.SetValue("three", 3)
      Console.WriteLine("[3]:   {0}", myArr1.GetValue(3))


      ' Creates and initializes a two-dimensional array. 
      Dim myArr2(5, 5) As [String]

      ' Sets the element at index 1,3.
      myArr2.SetValue("one-three", 1, 3)
      Console.WriteLine("[1,3]:   {0}", myArr2.GetValue(1, 3))


      ' Creates and initializes a three-dimensional array. 
      Dim myArr3(5, 5, 5) As [String]

      ' Sets the element at index 1,2,3.
      myArr3.SetValue("one-two-three", 1, 2, 3)
      Console.WriteLine("[1,2,3]:   {0}", myArr3.GetValue(1, 2, 3))


      ' Creates and initializes a seven-dimensional array. 
      Dim myArr7(5, 5, 5, 5, 5, 5, 5) As [String]

      ' Sets the element at index 1,2,3,0,1,2,3. 
      Dim myIndices() As Integer = {1, 2, 3, 0, 1, 2, 3}
      myArr7.SetValue("one-two-three-zero-one-two-three", myIndices)
      Console.WriteLine("[1,2,3,0,1,2,3]:   {0}", myArr7.GetValue(myIndices))

   End Sub 'Main 

End Class 'SamplesArray


'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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft