VCCodeModel.AddInclude(String, Object, Object) Method

Definition

Namespace:

Microsoft.VisualStudio.VCCodeModel

Assembly:

Microsoft.VisualStudio.VCCodeModel.dll

Adds a #include element to a specific file.

Microsoft::VisualStudio::VCCodeModel::VCCodeInclude AddInclude(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Location, winrt::Windows::Foundation::IInspectable const & Position);

[System.Runtime.InteropServices.DispId(568)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeInclude AddInclude (string Name, object Location, object Position);

[<System.Runtime.InteropServices.DispId(568)>]
abstract member AddInclude : string * obj * obj -> Microsoft.VisualStudio.VCCodeModel.VCCodeInclude

Public Function AddInclude (Name As String, Location As Object, Optional Position As Object) As VCCodeInclude

Parameters

Name

String

Required. Specifies the name (in quotes or angle brackets) of the file being included.

Location

Object

Required. The path or file name of the file to be modified. If the file does not exist, it is created automatically. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddInclude(String, Object, Object) fails.

Position

Object

Required. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.Since collections begin their count at one, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Returns

VCCodeInclude

A VCCodeInclude object.

Attributes

DispIdAttribute

Examples

This example adds a #include statement to the stdafx.h file.

Sub AddInclude()  
    Dim codeModel As VCCodeModel  
    codeModel = DTE.Solution.Item(1).CodeModel  
    Dim include As VCCodeInclude  
    include = codeModel.AddInclude("""stdafx.h""", "File.h", 0)  
End Sub  

Remarks

Call this function to insert a #include Directive (C/C++) element into the specified file of the VCCodeModel object.

See How to: Compile Example Code for Visual C++ Code Model Extensibility for information on how to compile and run this sample.