IReceivableSourceBlock<TOutput>.TryReceiveAll Method

Reference

Definition

Namespace:: System.Threading.Tasks.Dataflow

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

Package:: System.Threading.Tasks.Dataflow v8.0.0

Package:: System.Threading.Tasks.Dataflow v9.0.0-preview.3.24172.9

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 all available items from the IReceivableSourceBlock<TOutput>.

public:
 bool TryReceiveAll([Runtime::InteropServices::Out] System::Collections::Generic::IList<TOutput> ^ % items);

public bool TryReceiveAll (out System.Collections.Generic.IList<TOutput> items);

public bool TryReceiveAll (out System.Collections.Generic.IList<TOutput>? items);

abstract member TryReceiveAll : IList -> bool

Public Function TryReceiveAll (ByRef items As IList(Of TOutput)) As Boolean

Parameters

items: IList<TOutput>

The items received from the source.

Returns

Boolean

true if one or more items could be received; otherwise, false.

Remarks

This method does not block waiting for the source to provide an item.

It will return after checking for elements, whether or not an element was available.

Applies to