• Article

Collection.ICollection.CopyTo Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Namespace:  Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Syntax

'Declaration
Private Sub ICollectionCopyTo ( _
    array As Array, _
    index As Integer _
) Implements ICollection.CopyTo

void ICollection.CopyTo(
    Array array,
    int index
)

Parameters

  • array
    Type: System.Array
    The one-dimensional Array that is the destination of the elements copied from Collection object. The Array must have zero-based indexing.
  • index
    Type: System.Int32
    The zero-based index in array at which copying begins.

Implements

ICollection.CopyTo(Array, Int32)

Exceptions

Exception Condition
ArgumentNullException

array is nulla null reference (Nothing in Visual Basic).
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.

Version Information

Silverlight

Supported in: 5, 4, 3

Platforms

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