SolutionBuild2.Clean(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.

Deletes all compiler-generated support files for marked projects.

void Clean(bool WaitForCleanToFinish = false);

[System.Runtime.InteropServices.DispId(11)]
public void Clean (bool WaitForCleanToFinish = false);

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

Public Sub Clean (Optional WaitForCleanToFinish As Boolean = false)

Parameters

WaitForCleanToFinish: Boolean

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

Implements

Clean(Boolean)

Attributes: DispIdAttribute

Examples

This example displays the number of build dependencies, and it then cleans the solution. Open a project in the Visual Studio integrated development environment (IDE) before running this example.

Imports EnvDTE  
Imports EnvDTE80  
Sub SolutionBuildCleanExample(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  
        Dim p1 As Project = soln.Projects.Item(1)  
        sb = CType(soln.SolutionBuild, SolutionBuild2)  
        bld = sb.BuildDependencies  
        MsgBox("The project " & bld.Item(1).Project.Name & " has "  _  
        & bld.Count.ToString() & " build dependencies.")  
        MsgBox("Clean the solution...")  
        sb.Clean()  
    Catch ex As System.Exception  
        MsgBox(ex.ToString)  
    End Try  
End Sub

using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void SolutionBuildCleanExample(DTE2 dte)  
{  
    try  
    {  
        Solution2 soln = (Solution2)_applicationObject.Solution;  
        SolutionBuild2 sb;  
        BuildDependencies bld;  
        Project p1 = soln.Projects.Item(1);  
        // 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("Clean the solution...");  
        sb.Clean(true);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}

Remarks

When a project is built, the compiler can generate numerous support files, such as, .idl files, .obj files, and so forth. The Clean method deletes all such files from all projects that are marked for build, returning the project to a state similar to never having been built.

Applies to