This documentation is archived and is not being maintained.

Array.SetValue Method (Object, Int32())

Sets a value to the element 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)

'Declaration
Public Sub SetValue ( _
	value As Object, _
	ParamArray indices As Integer() _
)
'Usage
Dim instance As Array 
Dim value As Object 
Dim indices As Integer()

instance.SetValue(value, indices)

Parameters

value
Type: System.Object

The new value for the specified element.

indices
Type: System.Int32()

A one-dimensional array of 32-bit integers that represent the indexes specifying the position of the element to set.

ExceptionCondition
ArgumentNullException

indices is Nothing.

ArgumentException

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

InvalidCastException

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

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 values in the indices array 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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: