Task.ConfigureAwait(Boolean) Method

Reference

Definition

Namespace:: System.Threading.Tasks

Assembly:: System.Threading.Tasks.dll

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

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.

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.

Applies to