IHost.StartAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

Assembly:: Microsoft.Extensions.Hosting.Abstractions.dll

Package:: Microsoft.Extensions.Hosting.Abstractions v10.0.0-preview.1.25080.5

Source:: IHost.cs

Source:: IHost.cs

Source:: IHost.cs

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.

Starts the IHostedService objects configured for the program. The application will run until interrupted or until StopApplication() is called.

public System.Threading.Tasks.Task StartAsync(System.Threading.CancellationToken cancellationToken = default);

abstract member StartAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function StartAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken: CancellationToken

Used to abort program start.

Returns

Task

A Task that will be completed when the IHost starts.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Applies to

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard	2.0 (package-provided), 2.1 (package-provided)

Share via