SolutionBuild2.ActiveConfiguration Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Gets the currently active SolutionConfiguration object.

public:
 property EnvDTE::SolutionConfiguration ^ ActiveConfiguration { EnvDTE::SolutionConfiguration ^ get(); };

public:
 property EnvDTE::SolutionConfiguration ^ ActiveConfiguration { EnvDTE::SolutionConfiguration ^ get(); };

[System.Runtime.InteropServices.DispId(3)]
public EnvDTE.SolutionConfiguration ActiveConfiguration { [System.Runtime.InteropServices.DispId(3)] get; }

[<System.Runtime.InteropServices.DispId(3)>]
[<get: System.Runtime.InteropServices.DispId(3)>]
member this.ActiveConfiguration : EnvDTE.SolutionConfiguration

Public ReadOnly Property ActiveConfiguration As SolutionConfiguration

Property Value

SolutionConfiguration

A SolutionConfiguration object.

Implements

ActiveConfiguration

Attributes: DispIdAttribute

Examples

This example determines the build status for each active startup configuration. Open a project in the Visual Studio integrated development environment (IDE) before running this example.

Imports EnvDTE  
Imports EnvDTE80  
Sub SolutionBuild2Example(ByVal dte As DTE2)  
    ' Open a solution in the Visual Studio IDE  
    ' before running this example.  
    Try  
        Dim sb As SolutionBuild2  
        sb = CType(_applicationObject.Solution.SolutionBuild _        , SolutionBuild2)  
        Dim sc As SolutionConfiguration2  
        sc = CType(sb.ActiveConfiguration, SolutionConfiguration2)  
        Dim vsBldSt As vsBuildState  
        Dim msg As String = "Return relative path to startup  _  
        projects: "  
        For Each s As String In CType(sb.StartupProjects, Array)  
            msg &= vbCr & " " & s  
        Next  
        msg &= vbCr & "SolutionConfiguration: " & sc.Name  
        vsBldSt = sb.BuildState  
        If (vsBldSt = vsBuildState.vsBuildStateDone) Then  
            msg &= vbCr & "A build has occured."  
        ElseIf (vsBldSt = vsBuildState.vsBuildStateInProgress) Then  
            msg &= vbCr & "A build is in progress."  
        Else : msg &= vbCr & "A build has not occurred."  
        End If  
        MsgBox(msg)  
    Catch ex As System.Exception  
        MsgBox(ex.ToString)  
    End Try  
End Sub

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void SolutionBuild2Example(DTE2 dte)  
{  
    try  
    {  
        SolutionBuild2 sb =  
 (SolutionBuild2)_applicationObject.Solution.SolutionBuild;  
        SolutionConfiguration2 sc =  
 (SolutionConfiguration2)sb.ActiveConfiguration;  
        vsBuildState vsBS;  
        string msg = "Return relative path to startup projects: ";  
        foreach (String s in (Array)sb.StartupProjects)  
        {  
            msg += "\n   " + s;  
        }  
        msg += "\nSolutionConfiguration: " + sc.Name;  
        vsBS = sb.BuildState;  
        if (vsBS == vsBuildState.vsBuildStateDone)  
            msg += "\nA build has occurred.";  
        else if (vsBS == vsBuildState.vsBuildStateInProgress)  
            msg += "\nA build is in progress.";  
        else msg += "\nA build has not occurred.";  
        MessageBox.Show(msg);  
    }  
    catch(Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}

Remarks

The SolutionConfiguration object represents the current solution configuration that is used if a solution build operation occurs.

Applies to

Share via