Share via


Copy Method (Array, Array, Int32)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Copies a range of elements from an Array starting at the first element and pastes them into another Array starting at the first element. The length is specified as a 32-bit integer.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Shared Sub Copy ( _
    sourceArray As Array, _
    destinationArray As Array, _
    length As Integer _
)
public static void Copy(
    Array sourceArray,
    Array destinationArray,
    int length
)
public:
static void Copy(
    Array^ sourceArray, 
    Array^ destinationArray, 
    int length
)
static member Copy : 
        sourceArray:Array * 
        destinationArray:Array * 
        length:int -> unit 
public static function Copy(
    sourceArray : Array, 
    destinationArray : Array, 
    length : int
)

Parameters

Exceptions

Exception Condition
ArgumentNullException

sourceArray is null Nothing nullptr unit a null reference (Nothing in Visual Basic) .

-or-

destinationArray is null Nothing nullptr unit a null reference (Nothing in Visual Basic) .

RankException

sourceArray and destinationArray have different ranks.

ArrayTypeMismatchException

sourceArray and destinationArray are of incompatible types.

InvalidCastException

At least one element in sourceArray cannot be cast to the type of destinationArray.

ArgumentOutOfRangeException

length is less than zero.

ArgumentException

length is greater than the number of elements in sourceArray.

-or-

length is greater than the number of elements in destinationArray.

Remarks

The sourceArray and destinationArray parameters must have the same number of dimensions.

When copying between multidimensional arrays, the array behaves like a long one-dimensional array, where the rows (or columns) are conceptually laid end to end. For example, if an array has three rows (or columns) with four elements each, copying six elements from the beginning of the array would copy all four elements of the first row (or column) and the first two elements of the second row (or column).

If sourceArray and destinationArray overlap, this method behaves as if the original values of sourceArray were preserved in a temporary ___location before destinationArray is overwritten.

The arrays can be reference-type arrays or value-type arrays. Type downcasting is performed, as required.

  • When copying from a reference-type array to a value-type array, each element is unboxed and then copied. When copying from a value-type array to a reference-type array, each element is boxed and then copied.

  • When copying from a reference-type or value-type array to an Object array, an Object is created to hold each value or reference and then copied. When copying from an Object array to a reference-type or value-type array and the assignment is not possible, an InvalidCastException is thrown.

  • If sourceArray and destinationArray are both reference-type arrays or are both arrays of type Object, a shallow copy is performed. A shallow copy of an Array is a new Array containing references to the same elements as the original Array. The elements themselves or anything referenced by the elements are not copied. In contrast, a deep copy of an Array copies the elements and everything directly or indirectly referenced by the elements.

An ArrayTypeMismatchException is thrown if the arrays are of incompatible types. Type compatibility is defined as follows:

  • A type is compatible with itself.

  • A value type is compatible with Object and with an interface type implemented by that value type. A value type is considered connected to an interface only if it implements that interface directly. Disconnected types are not compatible.

  • Two intrinsic (predefined) value types are compatible if copying from the source type to the destination type is a widening conversion. A widening conversion never loses information, whereas a narrowing conversion can lose information. For example, converting a 32-bit signed integer to a 64-bit signed integer is a widening conversion, and converting a 64-bit signed integer to a 32-bit signed integer is a narrowing conversion. For more information about conversions, see Convert.

  • A nonintrinsic (user-defined) value type is compatible only with itself.

  • Enumerations have an implicit conversion to Enum and to their underlying type.

If every element in sourceArray requires a downcast (for example, from a base class to a derived class or from an interface to an object) and one or more elements cannot be cast to the corresponding type in destinationArray, an InvalidCastException is thrown.

If this method throws an exception while copying, the state of destinationArray is undefined.

This method is an O(n) operation, where n is length.

.NET Framework Security

See Also

Reference

Array Class

Copy Overload

System Namespace