DataflowBlock.TryReceive<TOutput> Method

Reference

Definition

Namespace:: System.Threading.Tasks.Dataflow

Assembly:: System.Threading.Tasks.Dataflow.dll

Source:: DataflowBlock.cs

Source:: DataflowBlock.cs

Source:: DataflowBlock.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to