TaskContinuationOptions Enumeration

July 28, 2014

Specifies the behavior for a task that is created by using the ContinueWith() or ContinueWith() method.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

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

[FlagsAttribute]
public enum TaskContinuationOptions

Member nameDescription
AttachedToParentSpecifies that a task is attached to a parent in the task hierarchy.
DenyChildAttachSpecifies that an InvalidOperationException will be thrown if an attempt is made to attach a child task to the created task.
ExecuteSynchronouslySpecifies that the continuation task should be executed synchronously. With this option specified, the continuation will be run on the same thread that causes the antecedent task to transition into its final state. If the antecedent is already complete when the continuation is created, the continuation will run on the thread creating the continuation. Only very short-running continuations should be executed synchronously.
HideSchedulerPrevents the ambient scheduler from being seen as the current scheduler in the created task. This means that operations like StartNew or ContinueWith that are performed in the created task will see Default as the current scheduler.
LazyCancellationIn the case of continuation cancellation, prevents completion of the continuation until the antecedent has completed.
LongRunningSpecifies that a task will be a long-running, course-grained operation. It provides a hint to the TaskScheduler that oversubscription may be warranted.
NoneDefault = "Continue on any, no task options, run asynchronously" Specifies that the default behavior should be used. Continuations, by default, will be scheduled when the antecedent task completes, regardless of the task's final TaskStatus.
NotOnCanceledSpecifies that the continuation task should not be scheduled if its antecedent was canceled. This option is not valid for multi-task continuations.
NotOnFaultedSpecifies that the continuation task should not be scheduled if its antecedent threw an unhandled exception. This option is not valid for multi-task continuations.
NotOnRanToCompletionSpecifies that the continuation task should not be scheduled if its antecedent ran to completion. This option is not valid for multi-task continuations.
OnlyOnCanceledSpecifies that the continuation task should be scheduled only if its antecedent was canceled. This option is not valid for multi-task continuations.
OnlyOnFaultedSpecifies that the continuation task should be scheduled only if its antecedent threw an unhandled exception. This option is not valid for multi-task continuations.
OnlyOnRanToCompletionSpecifies that the continuation task should be scheduled only if its antecedent ran to completion. This option is not valid for multi-task continuations.
PreferFairnessA hint to a TaskScheduler to schedule a task in as fair a manner as possible, meaning that tasks scheduled sooner will be more likely to be run sooner, and tasks scheduled later will be more likely to be run later.

Windows Phone OS

Supported in: 8.1, 8.0

Show:
© 2014 Microsoft