Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

BlockingCollection<T>.TryAddToAny Method (BlockingCollection<T>[], T, TimeSpan)

Tries to add the specified item to any one of the specified BlockingCollection<T> instances while observing the specified cancellation token.

Namespace:  System.Collections.Concurrent
Assembly:  System (in System.dll)
public static int TryAddToAny(
	BlockingCollection<T>[] collections,
	T item,
	TimeSpan timeout
)

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.

timeout
Type: System.TimeSpan

A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

Return Value

Type: System.Int32
The index of the collection in the collections array to which the item was added, or -1 if the item could not be added.
ExceptionCondition
ObjectDisposedException

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

ArgumentNullException

The collections argument is null.

ArgumentOutOfRangeException

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.

-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, or at least one of collections has been marked as complete for adding.

InvalidOperationException

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

This method can return early if the cancellationToken is cancelled before space was available for the Add operation.

.NET Framework

Supported in: 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.