Array.SetValue Method (Object, Int32, Int32, Int32)

Sets a value to the element at the specified position in the three-dimensional Array. The indexes are specified as 32-bit integers.

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

'Declaration
Public Sub SetValue ( _
	value As Object, _
	index1 As Integer, _
	index2 As Integer, _
	index3 As Integer _
)

Parameters

value
Type: System.Object
The new value for the specified element.
index1
Type: System.Int32
A 32-bit integer that represents the first-dimension index of the Array element to set.
index2
Type: System.Int32
A 32-bit integer that represents the second-dimension index of the Array element to set.
index3
Type: System.Int32
A 32-bit integer that represents the third-dimension index of the Array element to set.

ExceptionCondition
ArgumentException

The current Array does not have exactly three dimensions.

InvalidCastException

value cannot be cast to the element type of the current Array.

IndexOutOfRangeException

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.

For more information about conversions, see Convert.

This method is an O(1) operation.

NoteNote

If SetValue is used to assign Nothing to an element of an array of value types, all fields of the element are initialized to zero. The value of the element is not a null reference, and cannot be found by searching for a null reference.

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, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft