CodeAnalysisProgress.AddIncompleteItems(Int32, String) Method

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.9.2

Source:

CodeAnalysisProgress.cs

When passed to an appropriate IProgress<T>, will add the requested number of incomplete items to the UI showing the progress of the current operation. This is commonly presented with a progress bar. An optional description can also be provided to update the UI accordingly (see Description(String)).

public static Microsoft.CodeAnalysis.CodeAnalysisProgress AddIncompleteItems (int count, string? description = default);

static member AddIncompleteItems : int * string -> Microsoft.CodeAnalysis.CodeAnalysisProgress

Public Shared Function AddIncompleteItems (count As Integer, Optional description As String = Nothing) As CodeAnalysisProgress

Parameters

count

Int32

The number of incomplete items left to perform.

description

String

Optional description to update the UI to.

Returns

CodeAnalysisProgress

Examples

progress.Report(CodeAnalysisProgress.AddIncompleteItems(20));