This documentation is archived and is not being maintained.

BlockingCollection<T>.TryAdd Method (T)

Tries to add the specified item to the BlockingCollection<T>.

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

public bool TryAdd(
	T item
)

Parameters

item
Type: T
The item to be added to the collection.

Return Value

Type: System.Boolean
true if item could be added; otherwise false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an InvalidOperationException is thrown.

ExceptionCondition
ObjectDisposedException

The BlockingCollection<T> 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 the collection is a bounded collection, and is full, this method immediately returns false without adding the item.

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