This topic has not yet been rated - Rate this topic

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

.NET Framework 4.5

Other Versions

.NET Framework 4

Tries to add the specified item to the BlockingCollection<T> within the specified time period.

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

Syntax

C++

public bool TryAdd(
	T item,
	int millisecondsTimeout
)

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.

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.

Exceptions

Exception	Condition
ObjectDisposedException	The BlockingCollection<T> 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.

Exception

Condition

ObjectDisposedException

The BlockingCollection<T> 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.

Version Information

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

BlockingCollection<T> Class

TryAdd Overload

System.Collections.Concurrent Namespace

Other Resources

Thread-Safe Collections

BlockingCollection Overview

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)