VCProject.RemoveFile(Object) VCProject.RemoveFile(Object) VCProject.RemoveFile(Object) VCProject.RemoveFile(Object) VCProject.RemoveFile(Object) VCProject.RemoveFile(Object) Method

Definition

Removes a file from the current project or folder.

public:
 void RemoveFile(System::Object ^ File);
public:
 void RemoveFile(Platform::Object ^ File);
void RemoveFile(winrt::Windows::Foundation::IInspectable const & File);
[System.Runtime.InteropServices.DispId(806)]
public void RemoveFile (object File);
abstract member RemoveFile : obj -> unit
Public Sub RemoveFile (File As Object)
Parameters
File
Object Object Object Object Object Object

Required. The file to remove.

Examples

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):

' 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  

Remarks

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.

Applies to