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

.NET Framework 4.6 and 4.5

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

Namespace:  System.Collections.Concurrent
Assemblies:   System.Collections.Concurrent (in System.Collections.Concurrent.dll)
  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.

ExceptionCondition
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.

.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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft