Collection.ICollection.CopyTo(Array, Int32) Method

Definition

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.dll

Copies the elements of the Collection to an Array, starting at a particular Array index.

 virtual void ICollectionCopyTo(Array ^ array, int index) = System::Collections::ICollection::CopyTo;

void ICollection.CopyTo (Array array, int index);

abstract member ICollectionCopyTo : Array * int -> unit
override this.ICollectionCopyTo : Array * int -> unit

Sub ICollectionCopyTo (array As Array, index As Integer) Implements ICollection.CopyTo

Parameters

array

Array

The one-dimensional Array that is the destination of the elements copied from Collection object. The Array must have zero-based indexing.

index

Int32

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

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

index is less than zero.

ArgumentException

array is multidimensional.

-or-

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

InvalidCastException

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

Remarks

The elements are copied to the Array in the same order in which the enumerator iterates through the Collection object.

This method is an O(n) operation, where n is obtained from the ICollection.Count.

See also

• Collection
• ICollection
• CopyTo(Array, Int32)
• Array