Export (0) Print
Expand All

BlockingCollection<T>.AddToAny Method (BlockingCollection<T>[], T, CancellationToken)

Adds the specified item to any one of the specified BlockingCollection<T> instances.

Namespace:  System.Collections.Concurrent
Assembly:  System (in System.dll)

public static int AddToAny(
	BlockingCollection<T>[] collections,
	T item,
	CancellationToken cancellationToken
)

Parameters

collections
Type: System.Collections.Concurrent.BlockingCollection<T>[]

The array of collections.

item
Type: T

The item to be added to one of the collections.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token to observe.

Return Value

Type: System.Int32
The index of the collection in the collections array to which the item was added.

ExceptionCondition
OperationCanceledException

If the CancellationToken is canceled.

InvalidOperationException

At least one underlying collection didn't accept the item.

ArgumentNullException

The collections argument is null.

ArgumentOutOfRangeException

The count of collections is greater than the maximum size of 62 for STA and 63 for MTA.

ArgumentException

The collections argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.

ObjectDisposedException

At least one of the BlockingCollection<T> instances has been disposed, or the CancellationTokenSource that created cancellationToken has been disposed.

If a bounded capacity was specified when all of the BlockingCollection<T> instances were initialized, a call to AddToAny may block until space is available in one of the collections to store the provided item. This method may return before the item is added to any collection if the cancellationToken is canceled before space is available.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1
Show:
© 2015 Microsoft