VCFilter.RemoveFile Method

Removes a file from the current filter.

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

Syntax

'Declaration
Sub RemoveFile ( _
    File As Object _
)
void RemoveFile(
    Object File
)
void RemoveFile(
    [InAttribute] Object^ File
)
abstract RemoveFile : 
        File:Object -> unit
function RemoveFile(
    File : Object
)

Parameters

  • File
    Type: Object

    Required. The file to remove.

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.

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

.NET Framework Security

See Also

Reference

VCFilter Interface

Microsoft.VisualStudio.VCProjectEngine Namespace