Take Method
Collapse the table of content
Expand the table of content

BlockingCollection<T>.Take Method ()

.NET Framework (current version)
 

Removes an item from the BlockingCollection<T>.

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

public T Take()

Return Value

Type: T

The item removed from the collection.

Exception Condition
ObjectDisposedException

The BlockingCollection<T> has been disposed.

InvalidOperationException

The underlying collection was modified outside of this BlockingCollection<T> instance, or the BlockingCollection<T> is empty and the collection has been marked as complete for adding.

A call to Take may block until an item is available to be removed.

The order in which an item is removed depends on the type of collection used to create the BlockingCollection<T> instance. When you create a BlockingCollection<T> object, you can specify the type of collection to use. For example, you could specify a ConcurrentQueue<T> object for first in, first out (FIFO) behavior, or a ConcurrentStack<T> object for last in, first out (LIFO) behavior. You can use any collection class that implements the IProducerConsumerCollection<T> interface. The default collection type for BlockingCollection<T> is ConcurrentQueue<T>.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft