VCFilter.RemoveFile(Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

Package:: Microsoft.VisualStudio.VCProjectEngine v17.11.40252

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.

Removes a file from the current filter.

public:
 void RemoveFile(System::Object ^ File);

public:
 void RemoveFile(Platform::Object ^ File);

void RemoveFile(winrt::Windows::Foundation::IInspectable const & File);

[System.Runtime.InteropServices.DispId(2350)]
public void RemoveFile (object File);

[<System.Runtime.InteropServices.DispId(2350)>]
abstract member RemoveFile : obj -> unit

Public Sub RemoveFile (File As Object)

Parameters

File: Object

Required. The file to remove.

Attributes: DispIdAttribute

Examples

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

' Macro code.  
' add reference to Microsoft.VisualStudio.VCProjectEngine  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  

Public Module Module1  
    Sub Test()  
        Dim idx As Integer  
        Dim filter As VCFilter  
        Dim file As VCFile  
        Dim col As IVCCollection  
        Dim prj, prj2 As VCProject  
        prj = DTE.Solution.Projects.Item(1).Object  
        col = prj.Filters  
        filter = col.Item("MyFolder")  
        col = filter.Files  
        file = col.Item("x.x")  
        filter.RemoveFile(file)  
    End Sub  
End Module

Remarks

RemoveFile can be called on a VCProject or VCFilter object. Either removes 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.

Applies to

Share via