SolutionBuild2 Interface

Definition

Namespace:

EnvDTE80

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Represents the root of the build automation model at the solution level.

public interface class SolutionBuild2 : EnvDTE::SolutionBuild

public interface class SolutionBuild2 : EnvDTE::SolutionBuild

__interface SolutionBuild2 : EnvDTE::SolutionBuild

[System.Runtime.InteropServices.Guid("C2516E4B-5D69-459D-B539-C95A71C4FA3D")]
public interface SolutionBuild2 : EnvDTE.SolutionBuild

[<System.Runtime.InteropServices.Guid("C2516E4B-5D69-459D-B539-C95A71C4FA3D")>]
type SolutionBuild2 = interface
    interface SolutionBuild

Public Interface SolutionBuild2
Implements SolutionBuild

Attributes

GuidAttribute

Implements

SolutionBuild

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

The SolutionBuild object provides access to all solution configurations and their properties, the project build dependencies, and startup projects.

The counterpart to the SolutionBuild object at the project and item level is the ConfigurationManager object.

Properties

ActiveConfiguration	Gets the currently active SolutionConfiguration object.
BuildDependencies	Gets a BuildDependencies collection that allows you to specify which projects depend on which other projects.
BuildState	Gets whether a build has ever been started in the current environment session, whether a build is currently in progress, or whether a build has been completed.
DTE	Gets the top-level extensibility object.
LastBuildInfo	Gets the number of projects that failed to build.
LastPublishInfo	Gets the number of items that were successfully published.
Parent	Gets the immediate parent object of a SolutionBuild object.
PublishState	Gets the state of a publish operation.
SolutionConfigurations	Gets a collection of SolutionConfiguration objects.
StartupProjects	Gets or sets the names of projects that are entry points for the application.

Methods

Build(Boolean)	Causes the active solution configuration to begin building.
BuildProject(String, String, Boolean)	Builds the specified project and its dependencies in the context of the specified solution configuration.
Clean(Boolean)	Deletes all compiler-generated support files for marked projects.
Debug()	Starts debugging the solution.
Deploy(Boolean)	Causes each project in the active solution configuration that is marked for deployment to deploy.
DeployProject(String, String, Boolean)	Deploys a project.
Publish(Boolean)	Initiates a publish operation.
PublishProject(String, String, Boolean)	Publishes a project.
Run()	Causes the active solution configuration to execute.