Solution4.Close Method

  • Article

Closes the current solution.

Namespace:  EnvDTE100
Assembly:  EnvDTE100 (in EnvDTE100.dll)

Syntax

'Declaration
Sub Close ( _
    SaveFirst As Boolean _
)

void Close(
    bool SaveFirst
)

void Close(
    [InAttribute] bool SaveFirst
)

abstract Close : 
        SaveFirst:bool -> unit

function Close(
    SaveFirst : boolean
)

Parameters

  • SaveFirst
    Type: System.Boolean

    Optional. Indicates whether to save the solution before closing it; true if the solution should be saved prior to closing it, false if not.

Examples

For information on how to run this add-in code, see How to: Compile and Run the Automation Object Model Code Examples.

Public Sub OnConnection(ByVal application As Object, _
 ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
 ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    SolnCloseExample(_applicationObject)
End Sub

Sub SolnCloseExample(ByVal dte As DTE2)
    ' This add-in closes a solution.
    ' Make sure you have a solution open in Visual 
    ' Studio before running this example.
    Try
        Dim soln As Solution4 = CType(_applicationObject.Solution, _
        Solution4)
        Dim solnName As String = _
        System.IO.Path.GetFileNameWithoutExtension(soln.FullName)
        MsgBox("Closing the solution " & solnName)
        soln.Close()
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
End Sub

using System.Windows.Forms;
public void OnConnection(object application,
 Extensibility.ext_ConnectMode connectMode, object addInInst,
 ref System.Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    // Pass the applicationObject member variable to the code example.
    SolnCloseExample((DTE2)_applicationObject);
}

public void SolnCloseExample(DTE2 dte)
{
    // This add-in closes a  solution.
    // Open a solution in 
    // Visual Studio before running this example.
    try
    {
        Solution4 soln = (Solution4)_applicationObject.Solution;
        string solnName =
          System.IO.Path.GetFileNameWithoutExtension(soln.FullName);
        MessageBox.Show("Closing the solution " + solnName);
        soln.Close(true);
    }
    catch(SystemException ex)
    {
        MessageBox.Show("ERROR: " + ex);
    }
}

.NET Framework Security

See Also

Reference

Solution4 Interface

EnvDTE100 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples