This documentation is archived and is not being maintained.

BlockingCollection<T>.TryTakeFromAny Method (BlockingCollection<T>[], T%, Int32, CancellationToken)

Tries to remove an item from any one of the specified BlockingCollection<T> instances.

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

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

Parameters

collections
Type: System.Collections.Concurrent.BlockingCollection<T>[]
The array of collections.
item
Type: T%
The item removed from one of the collections.
millisecondsTimeout
Type: System.Int32
The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.
cancellationToken
Type: System.Threading.CancellationToken
A cancellation token to observe.

Return Value

Type: System.Int32
The index of the collection in the collections array from which the item was removed, or -1 if an item could not be removed.

ExceptionCondition
OperationCanceledException

If the CancellationToken is canceled.

InvalidOperationException

At least one of the underlying collections was modified outside of its BlockingCollection<T> instance.

ArgumentNullException

The collections argument is null.

ArgumentOutOfRangeException

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

-or-

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.

ObjectDisposedException

At least one of the BlockingCollection<T> instances has been disposed.

A call to TryTakeFromAny may block until an item is available to be removed.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: