VCProject.AddFile(String) 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.

Adds a file to the current project or folder.

public:
 System::Object ^ AddFile(System::String ^ bstrPath);

public:
 Platform::Object ^ AddFile(Platform::String ^ bstrPath);

winrt::Windows::Foundation::IInspectable AddFile(std::wstring const & bstrPath);

[System.Runtime.InteropServices.DispId(803)]
public object AddFile (string bstrPath);

[<System.Runtime.InteropServices.DispId(803)>]
abstract member AddFile : string -> obj

Public Function AddFile (bstrPath As String) As Object

Parameters

bstrPath: String

Required. The name of the file to add to the project or folder.

Returns

Object

A VCFile object for the file just added.

Attributes: DispIdAttribute

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 AddFile 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 file As VCFile  
        prj = DTE.Solution.Projects.Item(1).Object  
        file = prj.AddFile("file.cpp")  
        MsgBox(file.Name.ToString())  
    End Sub  
End Module

Remarks

AddFile behavior on a VCProject object depends on the file's extension. If a file has an extension specified with the Filter property, the file is added to the appropriate folder. Otherwise the file is placed at the end of the Solution Explorer list.

AddFile on a VCFilter object causes the file to be placed in the specified folder, regardless of the file's extension.

Adding a file in this way does not create the file on disk. The caller is responsible for handling that, if necessary.

AddFile on a VCFile object specifies the name of a file to associate with the file.

Applies to

Share via