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.

ActionBlock<TInput>::Completion Property

 

Gets a Task object that represents the asynchronous operation and completion of the dataflow block.

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

public:
property Task^ Completion {
	virtual Task^ get() sealed;
}

Property Value

Type: System.Threading.Tasks::Task^

The completed task.

A dataflow block is considered completed when it is not currently processing a message and when it has guaranteed that it will not process any more messages. The returned Task will transition to a completed state when the associated block has completed. It will transition to the RanToCompletion state when the block completes its processing successfully according to the dataflow block’s defined semantics. It will transition to the Faulted state when the dataflow block has completed processing prematurely due to an unhandled exception, and it will transition to the Canceled state when the dataflow block has completed processing prematurely after receiving a cancellation request. If the task completes in the Faulted state, its Exception property returns an AggregateException exception that contains one or more exceptions that caused the block to fail.

The following example shows how to use the Completion property to wait for all messages to propagate through the network. This code example is part of a larger example provided for the How to: Specify the Degree of Parallelism in a Dataflow Block topic.

No code example is currently available or this language may not be supported.
Return to top
Show:
© 2017 Microsoft