Export (0) Print
Expand All

List(Of T).CopyTo Method (T())

Copies the entire List(Of T) to a compatible one-dimensional array, starting at the beginning of the target array.

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

'Declaration
Public Sub CopyTo ( _
	array As T() _
)

Parameters

array
Type: T()
The one-dimensional Array that is the destination of the elements copied from List(Of T). The Array must have zero-based indexing.

ExceptionCondition
ArgumentNullException

array is Nothing.

ArgumentException

The number of elements in the source List(Of T) is greater than the number of elements that the destination array can contain.

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 List(Of T).

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

The following code example demonstrates all three overloads of the CopyTo method. A List(Of T) of strings is created and populated with 5 strings. An empty string array of 15 elements is created, and the CopyTo(T()) method overload is used to copy all the elements of the list to the array beginning at the first element of the array. The CopyTo(T(), Int32) method overload is used to copy all the elements of the list to the array beginning at array index 6 (leaving index 5 empty). Finally, the CopyTo(Int32, T(), Int32, Int32) method overload is used to copy 3 elements from the list, beginning with index 2, to the array beginning at array index 12 (leaving index 11 empty). The contents of the array are then displayed.


Imports System.Collections.Generic

Public Class Example

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

      Dim dinosaurs As New List(Of String)

      dinosaurs.Add("Tyrannosaurus")
      dinosaurs.Add("Amargasaurus")
      dinosaurs.Add("Mamenchisaurus")
      dinosaurs.Add("Brachiosaurus")
      dinosaurs.Add("Compsognathus")

      outputBlock.Text &= vbCrLf
      For Each dinosaur As String In dinosaurs
         outputBlock.Text &= dinosaur & vbCrLf
      Next

      ' Declare an array with 15 elements (0 through 14).
      Dim array(14) As String

      dinosaurs.CopyTo(array)
      dinosaurs.CopyTo(array, 6)
      dinosaurs.CopyTo(2, array, 12, 3)

      outputBlock.Text &= vbLf & "Contents of the array:" & vbCrLf
      For Each dinosaur As String In array
         outputBlock.Text &= dinosaur & vbCrLf
      Next

   End Sub
End Class

' This code example produces the following output:
'
'Tyrannosaurus
'Amargasaurus
'Mamenchisaurus
'Brachiosaurus
'Compsognathus
'
'Contents of the array:
'Tyrannosaurus
'Amargasaurus
'Mamenchisaurus
'Brachiosaurus
'Compsognathus
'
'Tyrannosaurus
'Amargasaurus
'Mamenchisaurus
'Brachiosaurus
'Compsognathus
'
'Mamenchisaurus
'Brachiosaurus
'Compsognathus


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

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

Community Additions

ADD
Show:
© 2014 Microsoft