ShellExtensibility.StartProgressReportingAsync Method
Definition
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.
Overloads
| StartProgressReportingAsync(String, CancellationToken) |
Simple overload for starting progress reporting for background work. Work progress is not cancellable by user by default. |
| StartProgressReportingAsync(String, ProgressReporterOptions, CancellationToken) |
Start progress reporting for background work. |
StartProgressReportingAsync(String, CancellationToken)
Simple overload for starting progress reporting for background work. Work progress is not cancellable by user by default.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Shell.ProgressReporter> StartProgressReportingAsync (string workDisplayName, System.Threading.CancellationToken cancellationToken);member this.StartProgressReportingAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Shell.ProgressReporter>Public Function StartProgressReportingAsync (workDisplayName As String, cancellationToken As CancellationToken) As Task(Of ProgressReporter)Parameters
- workDisplayName
- String
Name of the background work.
- cancellationToken
- CancellationToken
Cancellation token.
Returns
Progress reporter used to report progress for the background work.
Applies to
StartProgressReportingAsync(String, ProgressReporterOptions, CancellationToken)
Start progress reporting for background work.
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Shell.ProgressReporter> StartProgressReportingAsync (string workDisplayName, Microsoft.VisualStudio.RpcContracts.ProgressReporting.ProgressReporterOptions options, System.Threading.CancellationToken cancellationToken);member this.StartProgressReportingAsync : string * Microsoft.VisualStudio.RpcContracts.ProgressReporting.ProgressReporterOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Shell.ProgressReporter>Public Function StartProgressReportingAsync (workDisplayName As String, options As ProgressReporterOptions, cancellationToken As CancellationToken) As Task(Of ProgressReporter)Parameters
- workDisplayName
- String
Name of the background work.
- options
- ProgressReporterOptions
Options for customizing progress reporting behaviors.
- cancellationToken
- CancellationToken
Cancellation token.
Returns
Progress reporter used to report progress for the background work.