VCFile.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(415)]
public object AddFile (string bstrPath);

[<System.Runtime.InteropServices.DispId(415)>]
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

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 bottom of the Solution Explorer hierarchy.

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