Export (0) Print
Expand All

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

Copies a range of elements from the List(Of T) to a compatible one-dimensional array, starting at the specified index of the target array.

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

'Declaration
Public Sub CopyTo ( _
	index As Integer, _
	array As T(), _
	arrayIndex As Integer, _
	count As Integer _
)
'Usage
Dim instance As List 
Dim index As Integer 
Dim array As T()
Dim arrayIndex As Integer 
Dim count As Integer

instance.CopyTo(index, array, arrayIndex, _
	count)

Parameters

index
Type: System.Int32

The zero-based index in the source List(Of T) at which copying begins.

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.

arrayIndex
Type: System.Int32

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

count
Type: System.Int32

The number of elements to copy.

ExceptionCondition
ArgumentNullException

array is Nothing.

ArgumentOutOfRangeException

index is less than 0.

-or-

arrayIndex is less than 0.

-or-

count is less than 0.

ArgumentException

index is equal to or greater than the Count of the source List(Of T).

-or-

The number of elements from index to the end of the source List(Of T) is greater than the available space from arrayIndex to the end of the destination array.

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
Imports System.Collections.Generic

Public Class Example

    Public Shared Sub Main()

        Dim dinosaurs As New List(Of String)

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

        Console.WriteLine()
        For Each dinosaur As String In dinosaurs
            Console.WriteLine(dinosaur)
        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)

        Console.WriteLine(vbLf & "Contents of the array:")
        For Each dinosaur As String In array
            Console.WriteLine(dinosaur)
        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

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

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft