Share via


VCCodeModel.AddInclude Method

Adds a #include element to a specific file.

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

Syntax

'Declaration
Function AddInclude ( _
    Name As String, _
    Location As Object, _
    Position As Object _
) As VCCodeInclude
VCCodeInclude AddInclude(
    string Name,
    Object Location,
    Object Position
)
VCCodeInclude^ AddInclude(
    String^ Name, 
    Object^ Location, 
    Object^ Position
)
abstract AddInclude : 
        Name:string * 
        Location:Object * 
        Position:Object -> VCCodeInclude
function AddInclude(
    Name : String, 
    Location : Object, 
    Position : Object
) : VCCodeInclude

Parameters

  • Name
    Type: System.String

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

  • Location
    Type: System.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 fails.

  • Position
    Type: System.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.

Return Value

Type: Microsoft.VisualStudio.VCCodeModel.VCCodeInclude
A VCCodeInclude object.

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.

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

.NET Framework Security

See Also

Reference

VCCodeModel Interface

Microsoft.VisualStudio.VCCodeModel Namespace