Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

DataflowBlock::Receive<TOutput> Method (ISourceBlock<TOutput>^, CancellationToken)

 

Synchronously receives a value from a specified source and provides a token to cancel the operation.

Namespace:   System.Threading.Tasks.Dataflow
Assembly:  System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)

public:
generic<typename TOutput>
[ExtensionAttribute]
static TOutput Receive(
	ISourceBlock<TOutput>^ source,
	CancellationToken cancellationToken
)

Parameters

source
Type: System.Threading.Tasks.Dataflow::ISourceBlock<TOutput>^

The source from which to receive the value.

cancellationToken
Type: System.Threading::CancellationToken

The token to use to cancel the receive operation.

Return Value

Type: TOutput

The received value.

Type Parameters

TOutput

The type of data contained in the source.

Exception Condition
ArgumentNullException

source is null.

InvalidOperationException

No item could be received from the source.

OperationCanceledException

The operation was canceled before an item was received from the source.

If the source successfully offered an item that was received by this operation, that item is returned even if a concurrent cancellation request occurs.

Return to top
Show:
© 2017 Microsoft