SolutionBuild2.Build(Boolean) Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Causes the active solution configuration to begin building.

void Build(bool WaitForBuildToFinish = false);

[System.Runtime.InteropServices.DispId(8)]
public void Build (bool WaitForBuildToFinish = false);

[<System.Runtime.InteropServices.DispId(8)>]
abstract member Build : bool -> unit

Public Sub Build (Optional WaitForBuildToFinish As Boolean = false)

Parameters

WaitForBuildToFinish: Boolean

Optional. Determines whether Build(Boolean) retains control until the build operation is complete. Default value is false.

Implements

Build(Boolean)

Attributes: DispIdAttribute

Examples

This example sets the first solution configurations item to "release" and then builds the solution. Open a project in the Visual Studio integrated development environment (IDE) before running this example.

Imports EnvDTE  
Imports EnvDTE80  
Sub SolutionBuild2BuildExample(ByVal dte As DTE2)  
    ' Open a solution in Visual Studio before running this example.  
    Try  
        Dim soln As Solution2 = CType(_applicationObject.Solution, _  
        Solution2)  
        Dim sb As SolutionBuild2  
        Dim bld As BuildDependencies  
        sb = CType(soln.SolutionBuild, SolutionBuild2)  
        bld = sb.BuildDependencies  
        MsgBox("The project " & bld.Item(1).Project.Name & " has "  _  
        & bld.Count.ToString() & " build dependencies.")  
        MsgBox("Set the configuration to release and build...")  
        sb.SolutionConfigurations.Item("Release").Activate()  
        sb.Build()  
    Catch ex As System.Exception  
        MsgBox(ex.ToString)  
    End Try  
End Sub

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void SolutionBuild2BuildExample(DTE2 dte)  
{  
    try  
    {  
        Solution2 soln = (Solution2)_applicationObject.Solution;  
        SolutionBuild2 sb;  
        BuildDependencies bld;  
        // Open a solution in Visual Studio before   
        // running this example.  
        sb = (SolutionBuild2)soln.SolutionBuild;  
        bld = sb.BuildDependencies;  
        MessageBox.Show("The project " + bld.Item(1).Project.Name   
+ " has " + bld.Count.ToString() + " build dependencies.");  
        MessageBox.Show("Set the configuration to release   
and build...");  
        sb.SolutionConfigurations.Item("Release").Activate();  
        sb.Build(true);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}

Remarks

If you set WaitForBuildToFinish to false — that is, control returns immediately after initiating a build — you can use the OnBuildDone event to determine when the build is complete.

Applies to