BlockingCollection<T>.TryAdd Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Tries to add the specified item to the BlockingCollection<T>.
| TryAdd(T, Int32) |
Tries to add the specified item to the BlockingCollection<T> within the specified time period. |
| TryAdd(T, Int32, CancellationToken) |
Tries to add the specified item to the BlockingCollection<T> within the specified time period, while observing a cancellation token. |
| TryAdd(T) |
Tries to add the specified item to the BlockingCollection<T>. |
| TryAdd(T, TimeSpan) |
Tries to add the specified item to the BlockingCollection<T>. |
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
Tries to add the specified item to the BlockingCollection<T> within the specified time period.
public:
bool TryAdd(T item, int millisecondsTimeout);public bool TryAdd(T item, int millisecondsTimeout);member this.TryAdd : 'T * int -> boolPublic Function TryAdd (item As T, millisecondsTimeout As Integer) As BooleanParameters
- item
- T
The item to be added to the collection.
- millisecondsTimeout
- Int32
The number of milliseconds to wait for the collection to accept the item, or Infinite (-1) to wait indefinitely.
Returns
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
The BlockingCollection<T> has been disposed.
millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
The BlockingCollection<T> has been marked as complete with regards to additions.
-or-
The underlying collection didn't accept the item.
See also
Applies to
.NET 9 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
| .NET Framework | 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
| UWP | 10.0 |
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
Tries to add the specified item to the BlockingCollection<T> within the specified time period, while observing a cancellation token.
public:
bool TryAdd(T item, int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);public bool TryAdd(T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);member this.TryAdd : 'T * int * System.Threading.CancellationToken -> boolPublic Function TryAdd (item As T, millisecondsTimeout As Integer, cancellationToken As CancellationToken) As BooleanParameters
- item
- T
The item to be added to the collection.
- millisecondsTimeout
- Int32
The number of milliseconds to wait for the collection to accept the item, or Infinite (-1) to wait indefinitely.
- cancellationToken
- CancellationToken
A cancellation token to observe.
Returns
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
The CancellationToken is canceled.
The BlockingCollection<T> has been disposed or the underlying CancellationTokenSource has been disposed.
millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.
The BlockingCollection<T> has been marked as complete with regards to additions.
-or-
The underlying collection didn't accept the item.
See also
Applies to
.NET 9 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
| .NET Framework | 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
| UWP | 10.0 |
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
Tries to add the specified item to the BlockingCollection<T>.
public:
bool TryAdd(T item);public bool TryAdd(T item);member this.TryAdd : 'T -> boolPublic Function TryAdd (item As T) As BooleanParameters
- item
- T
The item to be added to the collection.
Returns
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.
Exceptions
The BlockingCollection<T> has been disposed.
The BlockingCollection<T> has been marked as complete with regards to additions.
-or-
The underlying collection didn't accept the item.
Remarks
If the collection is a bounded collection, and is full, this method immediately returns false without adding the item.
See also
Applies to
.NET 9 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
| .NET Framework | 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
| UWP | 10.0 |
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
- Source:
- BlockingCollection.cs
Tries to add the specified item to the BlockingCollection<T>.
public:
bool TryAdd(T item, TimeSpan timeout);public bool TryAdd(T item, TimeSpan timeout);member this.TryAdd : 'T * TimeSpan -> boolPublic Function TryAdd (item As T, timeout As TimeSpan) As BooleanParameters
- item
- T
The item to be added to the collection.
- timeout
- TimeSpan
A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.
Returns
true if the item could be added to the collection within the specified time span; otherwise, false.
Exceptions
The BlockingCollection<T> has been disposed.
timeout is a negative number other than -1 milliseconds, which represents an infinite time-out
-or-
timeout is greater than Int32.MaxValue.
The BlockingCollection<T> has been marked as complete with regards to additions.
-or-
The underlying collection didn't accept the item.
See also
Applies to
.NET 9 and other versions
| Product | Versions |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
| .NET Framework | 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
| UWP | 10.0 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: