Task.ConfigureAwait Method
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.
ConfigureAwait(Boolean) |
Configures an awaiter used to await this Task. |
ConfigureAwait(ConfigureAwaitOptions) |
Configures an awaiter used to await this Task. |
- Source:
- Task.cs
- Source:
- Task.cs
- 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
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
Applies to
.NET 9 и други версии
Продукт | Версии |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
UWP | 10.0 |
- Source:
- Task.cs
- 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
An object used to await this task.
Exceptions
The options
argument specifies an invalid value.
Applies to
.NET 9 и .NET 8
Продукт | Версии |
---|---|
.NET | 8, 9 |
Обратна връзка за .NET
.NET е проект с отворен код. Изберете връзка, за да предоставите обратна връзка: