IReceivableSourceBlock<TOutput>.TryReceive Method
Definition
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 available output item from the IReceivableSourceBlock<TOutput>.
public:
bool TryReceive(Predicate<TOutput> ^ filter, [Runtime::InteropServices::Out] TOutput % item);
public bool TryReceive (Predicate<TOutput> filter, out TOutput item);
public bool TryReceive (Predicate<TOutput>? filter, out TOutput item);
abstract member TryReceive : Predicate<'Output> * 'Output -> bool
Public Function TryReceive (filter As Predicate(Of TOutput), ByRef item As TOutput) As Boolean
Parameters
- filter
- Predicate<TOutput>
The predicate value must successfully pass in order for it to be received. filter
may be null
, in which case all items will pass.
- item
- TOutput
The item received from the source.
Returns
true
if an item 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 an element, whether or not an element was available.