VCProject.RemoveFile Method

Removes a file from the current project or folder.

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: System.Object
  Required. The file to remove.

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.

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

VCProject Interface

Microsoft.VisualStudio.VCProjectEngine Namespace