BlockingCollection<T>.TryAdd Method (T, TimeSpan)

.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,
	TimeSpan timeout
)

Parameters

item
Type: T

The item to be added to the collection.

timeout
Type: System.TimeSpan

A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

Return Value

Type: System.Boolean
true if the item could be added to the collection within the specified time span; otherwise, false.

ExceptionCondition
ObjectDisposedException

The BlockingCollection<T> has been disposed.

ArgumentOutOfRangeException

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.

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

.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