BlockingCollection<T>.Add Method (T, CancellationToken)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Adds the item to the BlockingCollection<T>.

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

public void Add(
	T item,
	CancellationToken cancellationToken
)

Parameters

item
Type: T

The item to be added to the collection. The value can be a null reference.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token to observe.

Exception Condition
OperationCanceledException

If the CancellationToken is canceled.

ObjectDisposedException

The BlockingCollection<T> has been disposed or the CancellationTokenSource that owns cancellationToken has been disposed.

InvalidOperationException

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

-or-

The underlying collection didn't accept the item.

If a bounded capacity was specified when this instance of BlockingCollection<T> was initialized, a call to Add may block until space is available to store the provided item.

This method can return early with an OperationCanceledException if the cancellationToken is canceled.

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: