ArrayList: CopyTo

CopyTo

Copies all of the items to an array.



 Public Sub CopyTo(
	  ByRef DstArray As Variant,
	  Optional ByRef ArrayIndex As Variant )

Parameters

DstArray
[ByRef] Variant. The array to copy the items to.
ArrayIndex
[ByRef] Optional. Variant. The index to start copying items to in the destination array.

Remarks

Exceptions

Exception TypeCondition
ArgumentNullExceptionThe destination array is a null array.
ArgumentExceptiondstArray is Multi-Dimension.
- or -
The number of elements in the ArrayList is greater than thedestination array can contain.
InvalidCastExceptionElements in the ArrayList cannot beconverted to a compatible datatype of the dstArray.

Example

This example shows how to copy elements from an ArrayList into anexisting array, replacing any elements in the destination array.
Private Sub Main()     Create our initial story in a regular String array.    Dim story() As String    story = cArray.NewArray(ciString, "Humpty", "Dumpty", "sat", "on", "a", "wall.")         Display the current story.    Console.WriteLine "The initial story is:"    PrintValues story         Create a new story in an ArrayList.    Dim words As New ArrayList    words.Add "Peter"    words.Add "Rabbit"    words.Add "slept"    words.Add "under"    words.Add "a"    words.Add "tree."         Copies the third word to same word location in the array.    words.CopyToEx 2, story, 2, 1         Display the new story.    Console.WriteLine "The story with sat substituted by slept is:"    PrintValues story         Copies the first two elements to the first     two elements in the array.    words.CopyToEx 0, story, 0, 2         Display the story with the new name.    Console.WriteLine "The story with the name changed is:"    PrintValues story         Increase the size of the story array.    ReDim Preserve story(0 To 11)         Append the words to the end of the current story.    words.CopyTo story, 6         Display the final story.    Console.WriteLine "The final story is:"    PrintValues story         Wait for a user presses Return.    Console.ReadLineEnd SubPrivate Sub PrintValues(ByRef s() As String)    Dim i As Long        Console.WriteValue vbTab    For i = LBound(s) To UBound(s)        Console.WriteValue "{0} ", s(i)    Next i    Console.WriteLineEnd Sub This code produces the following output. The initial story is:     Humpty Dumpty sat on a wall. The story with sat substituted by slept is:     Humpty Dumpty slept on a wall. The story with the name changed is:     Peter Rabbit slept on a wall. The final story is:     Peter Rabbit slept on a wall. Peter Rabbit slept under a tree.

See Also

Class ArrayList Overview ArrayList Properties ArrayList Methods Contains CopyToEx