DataflowBlock.TryReceive<TOutput> Method

.NET Framework (current version)

Attempts to synchronously receive an item from the ISourceBlock<TOutput>.

Namespace:  System.Threading.Tasks.Dataflow
Assembly:  System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)

public static bool TryReceive<TOutput>(
	this IReceivableSourceBlock<TOutput> source,
	out TOutput item

Type Parameters


Specifies the type of data contained in the source.


Type: System.Threading.Tasks.Dataflow.IReceivableSourceBlock<TOutput>

The source from which to receive.

Type: TOutput

The item received from the source.

Return Value

Type: System.Boolean
true if an item could be received; otherwise, false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IReceivableSourceBlock<TOutput>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

This method does not wait until the source has an item to provide.

It will return whether or not an element was available.

.NET Framework

Supported in: 4.5

Portable Class Library

Supported in: Portable Class Library