List(Of T).CopyTo Method (T(), Int32)
Copies the entire List(Of T) to a compatible one-dimensional array, starting at the specified index of the target array.
Assembly: mscorlib (in mscorlib.dll)
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.
- arrayIndex
-
Type:
System.Int32
The zero-based index in array at which copying begins.
Implements
ICollection(Of T).CopyTo(T(), Int32)| Exception | Condition |
|---|---|
| ArgumentNullException | array is null. |
| ArgumentOutOfRangeException | arrayIndex is less than 0. |
| ArgumentException | The number of elements in 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 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
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1