Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

BlockingCollection<T>::TryAdd Method (T, Int32, CancellationToken)

.NET Framework (current version)
 

Tries to add the specified item to the BlockingCollection<T> within the specified time period, while observing a cancellation token.

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

public:
bool TryAdd(
	T item,
	int millisecondsTimeout,
	CancellationToken cancellationToken
)

Parameters

item
Type: T

The item to be added to the collection.

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::Boolean

true if the item could be added to the collection within the specified time; otherwise, false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an InvalidOperationException is thrown.

Exception Condition
OperationCanceledException

If the CancellationToken is canceled.

ObjectDisposedException

The BlockingCollection<T> has been disposed or the underlying CancellationTokenSource has been disposed.

ArgumentOutOfRangeException

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

InvalidOperationException

The BlockingCollection<T> has been marked as complete with regards to additions.

-or-

The underlying collection didn't accept the item.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show:
© 2017 Microsoft