SolutionBuild.BuildProject(String, String, Boolean) Method

Definition

Builds the specified project and its dependencies in the context of the specified solution configuration.

void BuildProject(std::wstring const & SolutionConfiguration, std::wstring const & ProjectUniqueName, bool WaitForBuildToFinish = false);
[System.Runtime.InteropServices.DispId(14)]
public void BuildProject (string SolutionConfiguration, string ProjectUniqueName, bool WaitForBuildToFinish = false);
[<System.Runtime.InteropServices.DispId(14)>]
abstract member BuildProject : string * string * bool -> unit
Public Sub BuildProject (SolutionConfiguration As String, ProjectUniqueName As String, Optional WaitForBuildToFinish As Boolean = false)

Parameters

SolutionConfiguration
String

Required. The name of the new solution configuration that provides the context in which to build the project.

ProjectUniqueName
String

Required. The project to build.

WaitForBuildToFinish
Boolean

Optional. Determines whether to wait for the build to complete. If true, then waits, otherwise, no.

Attributes

Remarks

BuildProject returns immediately. To determine when a solution build operation is complete, you must check the OnBuildDone event.

BuildProject does not affect the user interface (UI) in terms of changing the active solution configuration or selected project. To build the project relative to the active solution configuration, use DTE.SolutionBuild.ActiveConfiguration.Name.

BuildProject does affect the UI based on the DTE.SuppressUI flag in that the Status Bar flickers and the Output window and Task List are always updated.

The specified project and all its dependencies are built as long as the dependencies are checked to be built in the specified solution configuration.

Applies to