Share via

IBuildService.BuildAsync Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Workspace.Build
Assembly:
Microsoft.VisualStudio.Workspace.dll
Package:
Microsoft.VisualStudio.Workspace v17.12.18

Build a project incrementally by invoking a build context actions from a provider

public:
 System::Threading::Tasks::Task<Microsoft::VisualStudio::Workspace::Build::BuildProjectIncrementalResult ^> ^ BuildAsync(System::String ^ projectFile, System::String ^ projectFileTarget, System::Collections::Generic::HashSet<System::String ^> ^ selectedReferences, System::Collections::Generic::HashSet<System::String ^> ^ excludedProjects, Microsoft::VisualStudio::Workspace::Build::IBuildConfigurationContext ^ buildConfigurationContext, Microsoft::VisualStudio::Workspace::Build::BuildType buildType, bool enableIncrementalBuild, IProgress<Microsoft::VisualStudio::Workspace::IFileContextActionProgressUpdate ^> ^ progress, System::Threading::CancellationToken cancellationToken);
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Workspace.Build.BuildProjectIncrementalResult> BuildAsync (string projectFile, string projectFileTarget, System.Collections.Generic.HashSet<string> selectedReferences, System.Collections.Generic.HashSet<string> excludedProjects, Microsoft.VisualStudio.Workspace.Build.IBuildConfigurationContext buildConfigurationContext, Microsoft.VisualStudio.Workspace.Build.BuildType buildType, bool enableIncrementalBuild, IProgress<Microsoft.VisualStudio.Workspace.IFileContextActionProgressUpdate> progress, System.Threading.CancellationToken cancellationToken);
public System.Threading.Tasks.Task<Microsoft.VisualStudio.Workspace.Build.BuildProjectIncrementalResult> BuildAsync (string projectFile, string? projectFileTarget, System.Collections.Generic.HashSet<string> selectedReferences, System.Collections.Generic.HashSet<string> excludedProjects, Microsoft.VisualStudio.Workspace.Build.IBuildConfigurationContext buildConfigurationContext, Microsoft.VisualStudio.Workspace.Build.BuildType buildType, bool enableIncrementalBuild, IProgress<Microsoft.VisualStudio.Workspace.IFileContextActionProgressUpdate> progress, System.Threading.CancellationToken cancellationToken);
abstract member BuildAsync : string * string * System.Collections.Generic.HashSet<string> * System.Collections.Generic.HashSet<string> * Microsoft.VisualStudio.Workspace.Build.IBuildConfigurationContext * Microsoft.VisualStudio.Workspace.Build.BuildType * bool * IProgress<Microsoft.VisualStudio.Workspace.IFileContextActionProgressUpdate> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Workspace.Build.BuildProjectIncrementalResult>
Public Function BuildAsync (projectFile As String, projectFileTarget As String, selectedReferences As HashSet(Of String), excludedProjects As HashSet(Of String), buildConfigurationContext As IBuildConfigurationContext, buildType As BuildType, enableIncrementalBuild As Boolean, progress As IProgress(Of IFileContextActionProgressUpdate), cancellationToken As CancellationToken) As Task(Of BuildProjectIncrementalResult)

Parameters

projectFile
String

The project file context

projectFileTarget
String

Optional project target

selectedReferences
HashSet<String>

list of root project references to build, if null - all references

excludedProjects
HashSet<String>

list of excluded projects (typically user unloaded projects in solution case)

buildConfigurationContext
IBuildConfigurationContext

The build configuration context

buildType
BuildType

build type (build, rebuild, etc)

enableIncrementalBuild
Boolean

Enable incremental build (UTD check)

progress
IProgress<IFileContextActionProgressUpdate>

A progress monitor

cancellationToken
CancellationToken

Cancellation token

Returns

Task<BuildProjectIncrementalResult>

Info about the incremental build

Applies to