BlockingCollection<T>.TryAdd Method (T)

.NET Framework 4.6 and 4.5

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

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

.NET Framework Client Profile

Supported in: 4

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Portable Class Library

Supported in: Portable Class Library
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft