StringCollection.CopyTo Method (String(), Int32)


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

Copies the entire StringCollection values to a one-dimensional array of strings, starting at the specified index of the target array.

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

Public Sub CopyTo (
	array As String(),
	index As Integer


Type: System.String()

The one-dimensional array of strings that is the destination of the elements copied from StringCollection. The Array must have zero-based indexing.

Type: System.Int32

The zero-based index in array at which copying begins.

Exception Condition

array is null.


index is less than zero.


array is multidimensional.


The number of elements in the source StringCollection is greater than the available space from index to the end of the destination array.


The type of the source StringCollection cannot be cast automatically to the type of the destination array.

The specified array must be of a compatible type.

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

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

The following code example copies a StringCollection to an array.

Imports System
Imports System.Collections
Imports System.Collections.Specialized

Public Class SamplesStringCollection   

   Public Shared Sub Main()

      ' Creates and initializes a new StringCollection.
      Dim myCol As New StringCollection()
      Dim myArr() As [String] = {"RED", "orange", "yellow", "RED", "green", "blue", "RED", "indigo", "violet", "RED"}

      Console.WriteLine("Initial contents of the StringCollection:")

      ' Copies the collection to a new array starting at index 0.
      Dim myArr2(myCol.Count) As [String]
      myCol.CopyTo(myArr2, 0)

      Console.WriteLine("The new array contains:")
      Dim i As Integer
      For i = 0 To myArr2.Length - 1
         Console.WriteLine("   [{0}] {1}", i, myArr2(i))
      Next i

   End Sub 'Main

   Public Shared Sub PrintValues(myCol As IEnumerable)
      Dim obj As [Object]
      For Each obj In  myCol
         Console.WriteLine("   {0}", obj)
      Next obj
   End Sub 'PrintValues

End Class 'SamplesStringCollection 

'This code produces the following output.
'Initial contents of the StringCollection:
'   RED
'   orange
'   yellow
'   RED
'   green
'   blue
'   RED
'   indigo
'   violet
'   RED
'The new array contains:
'   [0] RED
'   [1] orange
'   [2] yellow
'   [3] RED
'   [4] green
'   [5] blue
'   [6] RED
'   [7] indigo
'   [8] violet
'   [9] RED

Universal Windows Platform
Available since 10
.NET Framework
Available since 1.1
Return to top