BlockingCollection<T>.Take メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
BlockingCollection<T>から項目を削除します。
オーバーロード
| 名前 | 説明 |
|---|---|
| Take() |
BlockingCollection<T>から項目を削除します。 |
| Take(CancellationToken) |
BlockingCollection<T>から項目を削除します。 |
Take()
BlockingCollection<T>から項目を削除します。
public:
T Take();
public T Take();
member this.Take : unit -> 'T
Public Function Take () As T
返品
コレクションから削除された項目。
例外
基になるコレクションがこの BlockingCollection<T> インスタンスの外部で変更されたか、 BlockingCollection<T> が空で、追加に関して完了としてマークされています。
注釈
Takeの呼び出しは、アイテムを削除できるようになるまでブロックされる場合があります。
項目が削除される順序は、 BlockingCollection<T> インスタンスの作成に使用されるコレクションの種類によって異なります。 BlockingCollection<T> オブジェクトを作成するときに、使用するコレクションの種類を指定できます。 たとえば、先入れ先出し (FIFO) 動作に対して ConcurrentQueue<T> オブジェクトを指定したり、最後の入力先出し (LIFO) 動作に ConcurrentStack<T> オブジェクトを指定したりできます。 IProducerConsumerCollection<T> インターフェイスを実装する任意のコレクション クラスを使用できます。 BlockingCollection<T>の既定のコレクションの種類はConcurrentQueue<T>。
こちらもご覧ください
適用対象
Take(CancellationToken)
BlockingCollection<T>から項目を削除します。
public:
T Take(System::Threading::CancellationToken cancellationToken);
public T Take(System.Threading.CancellationToken cancellationToken);
member this.Take : System.Threading.CancellationToken -> 'T
Public Function Take (cancellationToken As CancellationToken) As T
パラメーター
- cancellationToken
- CancellationToken
"take" 操作を取り消すために使用できるトークン。
返品
コレクションから削除された項目。
例外
基になるコレクションがこの BlockingCollection<T> インスタンスの外部で変更されたか、 BlockingCollection<T> が空で、追加に関して完了としてマークされています。
注釈
Takeの呼び出しは、アイテムを削除できるようになるか、トークンが取り消されるまでブロックされる場合があります。
項目が削除される順序は、 BlockingCollection<T> インスタンスの作成に使用されるコレクションの種類によって異なります。 BlockingCollection<T> オブジェクトを作成するときに、使用するコレクションの種類を指定できます。 たとえば、先入れ先出し (FIFO) 動作に対して ConcurrentQueue<T> オブジェクトを指定したり、最後の入力先出し (LIFO) 動作に ConcurrentStack<T> オブジェクトを指定したりできます。 IProducerConsumerCollection<T> インターフェイスを実装する任意のコレクション クラスを使用できます。 BlockingCollection<T>の既定のコレクションの種類はConcurrentQueue<T>。