DataflowBlock.TryReceive<TOutput> Method

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Package:

System.Threading.Tasks.Dataflow v9.0.0-rc.2.24473.5

Source:

DataflowBlock.cs

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

public:
generic <typename TOutput>
[System::Runtime::CompilerServices::Extension]
 static bool TryReceive(System::Threading::Tasks::Dataflow::IReceivableSourceBlock<TOutput> ^ source, [Runtime::InteropServices::Out] TOutput % item);

public static bool TryReceive<TOutput> (this System.Threading.Tasks.Dataflow.IReceivableSourceBlock<TOutput> source, out TOutput item);

static member TryReceive : System.Threading.Tasks.Dataflow.IReceivableSourceBlock<'Output> * 'Output -> bool

<Extension()>
Public Function TryReceive(Of TOutput) (source As IReceivableSourceBlock(Of TOutput), ByRef item As TOutput) As Boolean

Type Parameters

TOutput

Specifies the type of data contained in the source.

Parameters

source

IReceivableSourceBlock<TOutput>

The source from which to receive.

item

TOutput

The item received from the source.

Returns

Boolean

true if an item could be received; otherwise, false.

Remarks

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

It will return whether or not an element was available.