BlockingCollection<T>.CopyTo(T[], Int32) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Copies all of the items in the BlockingCollection<T> instance to a compatible one-dimensional array, starting at the specified index of the target array.
public:
void CopyTo(cli::array <T> ^ array, int index);public void CopyTo (T[] array, int index);member this.CopyTo : 'T[] * int -> unitPublic Sub CopyTo (array As T(), index As Integer)Parameters
- array
- T[]
The one-dimensional array that is the destination of the elements copied from the BlockingCollection<T> instance. The array must have zero-based indexing.
- index
- Int32
The zero-based index in array at which copying begins.
Exceptions
The BlockingCollection<T> has been disposed.
The array argument is null.
The index argument is less than zero.
The index argument is equal to or greater than the length of the array.
The destination array is too small to hold all of the BlockingCollection elements.
The array rank doesn't match.
The array type is incompatible with the type of the BlockingCollection elements.
Remarks
CopyTo represents a snapshot of the collection at a precise point in time. If other threads are adding or removing items while CopyTo is executing, then the elements returned by CopyTo might not represent the state of the collection.
