BlockingCollection<T>.TryAdd メソッド

定義

名前空間:

System.Collections.Concurrent

アセンブリ:

System.Collections.Concurrent.dll

BlockingCollection<T> に対して、指定した項目の追加を試みます。

オーバーロード

TryAdd(T, Int32)	指定した期間内に、BlockingCollection<T> に対して指定した項目の追加を試みます。
TryAdd(T, Int32, CancellationToken)	キャンセル トークンを観察しながら、指定した期間内に、BlockingCollection<T> に対して指定した項目の追加を試みます。
TryAdd(T)	BlockingCollection<T> に対して、指定した項目の追加を試みます。
TryAdd(T, TimeSpan)	BlockingCollection<T> に対して、指定した項目の追加を試みます。

TryAdd(T, Int32)

ソース:

BlockingCollection.cs

指定した期間内に、BlockingCollection<T> に対して指定した項目の追加を試みます。

public:
 bool TryAdd(T item, int millisecondsTimeout);

public bool TryAdd (T item, int millisecondsTimeout);

member this.TryAdd : 'T * int -> bool

Public Function TryAdd (item As T, millisecondsTimeout As Integer) As Boolean

パラメーター

item

T

コレクションに追加する項目。

millisecondsTimeout

Int32

コレクションがアイテムを受け入れるのを待機するミリ秒数、または Infinite (-1) が無期限に待機します。

戻り値

Boolean

指定した時間内にコレクションに item を追加できた場合は true。それ以外の場合は false。 項目が重複しており、基になるコレクションが項目の重複を受け入れない場合は、InvalidOperationException がスローされます。

例外

ObjectDisposedException

BlockingCollection<T> は破棄されています。

ArgumentOutOfRangeException

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。

InvalidOperationException

BlockingCollection<T> は、追加に関して完了としてマークされました。

- または -

基になるコレクションが項目を受け入れませんでした。

こちらもご覧ください

• スレッドセーフなコレクション
• BlockingCollection の概要

TryAdd(T, Int32, CancellationToken)

ソース:

BlockingCollection.cs

キャンセル トークンを観察しながら、指定した期間内に、BlockingCollection<T> に対して指定した項目の追加を試みます。

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 -> bool

Public Function TryAdd (item As T, millisecondsTimeout As Integer, cancellationToken As CancellationToken) As Boolean

パラメーター

item

T

コレクションに追加する項目。

millisecondsTimeout

Int32

コレクションがアイテムを受け入れるのを待機するミリ秒数、または Infinite (-1) が無期限に待機します。

cancellationToken

CancellationToken

観察するキャンセル トークン。

戻り値

Boolean

指定した時間内にコレクションに item を追加できた場合は true。それ以外の場合は false。 項目が重複しており、基になるコレクションが項目の重複を受け入れない場合は、InvalidOperationException がスローされます。

例外

OperationCanceledException

CancellationToken は取り消されます。

ObjectDisposedException

BlockingCollection<T> が破棄されているか、または基になっている CancellationTokenSource が破棄されています。

ArgumentOutOfRangeException

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。

InvalidOperationException

BlockingCollection<T> は、追加に関して完了としてマークされました。

- または -

基になるコレクションが項目を受け入れませんでした。

こちらもご覧ください

• スレッドセーフなコレクション
• BlockingCollection の概要

TryAdd(T)

ソース:

BlockingCollection.cs

BlockingCollection<T> に対して、指定した項目の追加を試みます。

public:
 bool TryAdd(T item);

public bool TryAdd (T item);

member this.TryAdd : 'T -> bool

Public Function TryAdd (item As T) As Boolean

パラメーター

item

T

コレクションに追加する項目。

戻り値

Boolean

item を追加できる場合は true。それ以外の場合は false。 項目が重複しており、基になるコレクションが項目の重複を受け入れない場合は、InvalidOperationException がスローされます。

例外

ObjectDisposedException

BlockingCollection<T> は破棄されています。

InvalidOperationException

BlockingCollection<T> は、追加に関して完了としてマークされました。

- または -

基になるコレクションが項目を受け入れませんでした。

注釈

コレクションが境界付きコレクションで、満杯の場合、このメソッドはアイテムを追加せずに直ちに false を返します。

こちらもご覧ください

• スレッドセーフなコレクション
• BlockingCollection の概要

TryAdd(T, TimeSpan)

ソース:

BlockingCollection.cs

BlockingCollection<T> に対して、指定した項目の追加を試みます。

public:
 bool TryAdd(T item, TimeSpan timeout);

public bool TryAdd (T item, TimeSpan timeout);

member this.TryAdd : 'T * TimeSpan -> bool

Public Function TryAdd (item As T, timeout As TimeSpan) As Boolean

パラメーター

item

T

コレクションに追加する項目。

timeout

TimeSpan

待機するミリ秒数を表す TimeSpan。無制限に待機する場合は、-1 ミリ秒を表す TimeSpan。

戻り値

Boolean

指定した期間内にコレクションに item を追加できた場合は true。それ以外の場合は false。

例外

ObjectDisposedException

BlockingCollection<T> は破棄されています。

ArgumentOutOfRangeException

timeout は-1 ミリ秒以外の負の数であり、これは無限タイムアウトを表します

または

timeout が Int32.MaxValue より大きい。

InvalidOperationException

BlockingCollection<T> は、追加に関して完了としてマークされました。

- または -

基になるコレクションが項目を受け入れませんでした。

こちらもご覧ください

• スレッドセーフなコレクション
• BlockingCollection の概要