Task.ConfigureAwait Method

Definition

Namespace:

System.Threading.Tasks

Assembly:

System.Runtime.dll

Overloads

ConfigureAwait(Boolean)	Configures an awaiter used to await this Task.
ConfigureAwait(ConfigureAwaitOptions)	Configures an awaiter used to await this Task.

ConfigureAwait(Boolean)

Source:

Task.cs

Configures an awaiter used to await this Task.

public:
 System::Runtime::CompilerServices::ConfiguredTaskAwaitable ConfigureAwait(bool continueOnCapturedContext);

public System.Runtime.CompilerServices.ConfiguredTaskAwaitable ConfigureAwait (bool continueOnCapturedContext);

member this.ConfigureAwait : bool -> System.Runtime.CompilerServices.ConfiguredTaskAwaitable

Public Function ConfigureAwait (continueOnCapturedContext As Boolean) As ConfiguredTaskAwaitable

Parameters

continueOnCapturedContext

Boolean

true to attempt to marshal the continuation back to the original context captured; otherwise, false.

Returns

ConfiguredTaskAwaitable

An object used to await this task.

Remarks

When an asynchronous method awaits a Task directly, continuation usually occurs in the same thread that created the task, depending on the async context. This behavior can be costly in terms of performance and can result in a deadlock on the UI thread. To avoid these problems, call Task.ConfigureAwait(false). For more information, see ConfigureAwait FAQ.

See also

• ConfigureAwait FAQ

ConfigureAwait(ConfigureAwaitOptions)

Source:

Task.cs

Configures an awaiter used to await this Task.

public:
 System::Runtime::CompilerServices::ConfiguredTaskAwaitable ConfigureAwait(System::Threading::Tasks::ConfigureAwaitOptions options);

public System.Runtime.CompilerServices.ConfiguredTaskAwaitable ConfigureAwait (System.Threading.Tasks.ConfigureAwaitOptions options);

member this.ConfigureAwait : System.Threading.Tasks.ConfigureAwaitOptions -> System.Runtime.CompilerServices.ConfiguredTaskAwaitable

Public Function ConfigureAwait (options As ConfigureAwaitOptions) As ConfiguredTaskAwaitable

Parameters

options

ConfigureAwaitOptions

Options used to configure how awaits on this task are performed.

Returns

ConfiguredTaskAwaitable

An object used to await this task.

Exceptions

ArgumentOutOfRangeException

The options argument specifies an invalid value.