AnalysisAlternateCollection.CopyTo Method

Article
10/20/2012

Copies all of the elements of the current AnalysisAlternateCollection to the specified one-dimensional array, starting at the specified destination array index.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in Microsoft.Ink.Analysis.dll)

Syntax

'Declaration
Public Sub CopyTo ( _
    alternates As AnalysisAlternate(), _
    index As Integer _
)
'Usage
Dim instance As AnalysisAlternateCollection 
Dim alternates As AnalysisAlternate()
Dim index As Integer

instance.CopyTo(alternates, index)

public void CopyTo(
    AnalysisAlternate[] alternates,
    int index
)

public:
void CopyTo(
    array<AnalysisAlternate^>^ alternates, 
    int index
)

public function CopyTo(
    alternates : AnalysisAlternate[], 
    index : int
)

Parameters

alternates
Type: array<Microsoft.Ink.AnalysisAlternate[]

The one-dimensional array that is the destination of elements copied from the collection. The array must have zero-based indexing.

index
Type: System.Int32

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

Remarks

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

An exception is thrown if:

The array parameter is a nulla null reference (Nothing in Visual Basic) reference.
The index parameter is less than zero.
The array parameter is multidimensional.
The index parameter is equal to or greater than the length of the array parameter.
The number of elements in the collection is higher than the available space from the index parameter to the end of the destination array parameter.

The type of the collection is cast automatically to the type of the destination array parameter. However, this method copies elements only to arrays of the same type as the elements of the collection or to arrays of type Object. Attempting to copy to another type of array causes an InvalidCastException exception to be thrown.

This method is synchronized.

Examples

This example fills part of an array of AnalysisAlternate objects with an AnalysisAlternateCollection, alternates. It starts at element 1 (the second element in a zero-based array) of the destination array alternateArray and leaves the first element of the destination array (with an index of 0) empty.

Dim alternateArray(alternates.Count) As AnalysisAlternate
alternates.CopyTo(alternateArray, 1)

            AnalysisAlternate[] alternateArray = new AnalysisAlternate[alternates.Count + 1];
            alternates.CopyTo(alternateArray, 1);

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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.

Version Information

.NET Framework

Supported in: 3.0

Share via