Article
11/17/2011

Array.SetValue Method (Object, array<Int32[])

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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)

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Sub SetValue ( _
    value As Object, _
    ParamArray indices As Integer() _
)

[SecuritySafeCriticalAttribute]
public void SetValue(
    Object value,
    params int[] indices
)

Parameters

value
Type: System.Object
The new value for the specified element.

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

Exceptions

Exception	Condition
ArgumentNullException	indices is nulla null reference (Nothing in Visual Basic).
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.

Remarks

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.

Note:
If SetValue is used to assign nulla null reference (Nothing in Visual Basic) 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.

Examples

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


Public Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)

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

      ' Sets the element at index 3.
      myArr1.SetValue("three", 3)
      outputBlock.Text += String.Format("[3]:   {0}", myArr1.GetValue(3)) & vbCrLf


      ' 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)
      outputBlock.Text += String.Format("[1,3]:   {0}", myArr2.GetValue(1, 3)) & vbCrLf


      ' 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)
      outputBlock.Text += String.Format("[1,2,3]:   {0}", myArr3.GetValue(1, 2, 3)) & vbCrLf


      ' 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)
      outputBlock.Text += String.Format("[1,2,3,0,1,2,3]:   {0}", myArr7.GetValue(myIndices)) & vbCrLf

   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

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

*/

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Share via