ArrayList.CopyTo Method (Int32, Array, Int32, Int32)

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Copies a range of elements from the ArrayList to a compatible one-dimensional Array, starting at the specified index of the target array.

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

Syntax

C++

public virtual void CopyTo(
	int index,
	Array array,
	int arrayIndex,
	int count
)

Parameters

index: Type: System.Int32
The zero-based index in the source ArrayList at which copying begins.

array: Type: System.Array
The one-dimensional Array that is the destination of the elements copied from ArrayList. The Array must have zero-based indexing.

arrayIndex: Type: System.Int32
The zero-based index in array at which copying begins.

count: Type: System.Int32
The number of elements to copy.

Exceptions

Exception	Condition
ArgumentNullException	array is null.
ArgumentOutOfRangeException	index is less than zero. -or- arrayIndex is less than zero. -or- count is less than zero.
ArgumentException	array is multidimensional. -or- index is equal to or greater than the Count of the source ArrayList. -or- The number of elements from index to the end of the source ArrayList is greater than the available space from arrayIndex to the end of the destination array.
InvalidCastException	The type of the source ArrayList cannot be cast automatically to the type of the destination array.

Remarks

The specified array must be of a compatible type.

This method uses Array.Copy to copy the elements.

The elements are copied to the Array in the same order in which the enumerator iterates through the ArrayList.

This method is an O(n) operation, where n is count.

Examples

The following code example shows how to copy an ArrayList into a one-dimensional System.Array.

C++

using System;
using System.Collections;
public class SamplesArrayList  {

   public static void Main()  {

      // Creates and initializes the source ArrayList.
      ArrayList mySourceList = new ArrayList();
      mySourceList.Add( "three" );
      mySourceList.Add( "napping" );
      mySourceList.Add( "cats" );
      mySourceList.Add( "in" );
      mySourceList.Add( "the" );
      mySourceList.Add( "barn" );

      // Creates and initializes the one-dimensional target Array.
      String[] myTargetArray = new String[15];
      myTargetArray[0] = "The";
      myTargetArray[1] = "quick";
      myTargetArray[2] = "brown";
      myTargetArray[3] = "fox";
      myTargetArray[4] = "jumped";
      myTargetArray[5] = "over";
      myTargetArray[6] = "the";
      myTargetArray[7] = "lazy";
      myTargetArray[8] = "dog";

      // Displays the values of the target Array.
      Console.WriteLine( "The target Array contains the following (before and after copying):" );
      PrintValues( myTargetArray, ' ' );

      // Copies the second element from the source ArrayList to the target Array, starting at index 7.
      mySourceList.CopyTo( 1, myTargetArray, 7, 1 );

      // Displays the values of the target Array.
      PrintValues( myTargetArray, ' ' );

      // Copies the entire source ArrayList to the target Array, starting at index 6.
      mySourceList.CopyTo( myTargetArray, 6 );

      // Displays the values of the target Array.
      PrintValues( myTargetArray, ' ' );

      // Copies the entire source ArrayList to the target Array, starting at index 0.
      mySourceList.CopyTo( myTargetArray );

      // Displays the values of the target Array.
      PrintValues( myTargetArray, ' ' );

   }

   public static void PrintValues( String[] myArr, char mySeparator )  {
      for ( int i = 0; i < myArr.Length; i++ )
         Console.Write( "{0}{1}", mySeparator, myArr[i] );
      Console.WriteLine();
   }

}


/* 
This code produces the following output.

The target Array contains the following (before and after copying):
 The quick brown fox jumped over the lazy dog
 The quick brown fox jumped over the napping dog
 The quick brown fox jumped over three napping cats in the barn
 three napping cats in the barn three napping cats in the barn

*/

Version Information

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1