BufferBlock<T>.TryReceiveAll(IList<T>) Method

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Source:

BufferBlock.cs

Attempts to synchronously receive all available items from the IReceivableSourceBlock<TOutput>.

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

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

abstract member TryReceiveAll : IList -> bool
override this.TryReceiveAll : IList -> bool

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

Parameters

items

IList<T>

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.