VCProject::RemoveFile Method (Object^)

Visual Studio 2015
 

Removes a file from the current project or folder.

Namespace:   Microsoft.VisualStudio.VCProjectEngine
Assembly:  Microsoft.VisualStudio.VCProjectEngine (in Microsoft.VisualStudio.VCProjectEngine.dll)

C#
C++
F#
VB
Copy 
void RemoveFile(
	Object^ File
)

Parameters

File
Type: System::Object^

Required. The file to remove.

RemoveFile can be called on a VCProject or VCFilter object. Either will remove the file from both its current folder, if one exists, and the project. RemoveFile does not delete the file from disk.

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

The following example uses RemoveFile on a VCProject object in the integrated development environment (IDE):

VB
Copy 
' add reference to Microsoft.VisualStudio.VCProjectEngine
Imports EnvDTE
Imports Microsoft.VisualStudio.VCProjectEngine

Public Module Module1
    Sub Test()
        Dim prj As VCProject
        Dim MyCol As IVCCollection
        Dim file As VCFile
        prj = DTE.Solution.Projects.Item(1).Object
        MyCol = prj.Files
        file = MyCol.Item("ReadMe.txt")
        prj.RemoveFile(file)
    End Sub
End Module
Return to top
Show: