VCFileCodeModel.AddInclude Method

Article
10/10/2013

Adds a #include element to the VCFileCodeModel object.

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

Syntax

'Declaration
Function AddInclude ( _
    Name As String, _
    Position As Object _
) As VCCodeInclude

VCCodeInclude AddInclude(
    string Name,
    Object Position
)

VCCodeInclude^ AddInclude(
    String^ Name, 
    Object^ Position
)

abstract AddInclude : 
        Name:string * 
        Position:Object -> VCCodeInclude

function AddInclude(
    Name : String, 
    Position : Object
) : VCCodeInclude

Parameters

Name
Type: System.String

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

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.

Because 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 file represented by the VCFileCodeModel 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 file represented by the vcFile object.

Sub AddInclude()
    Dim vcFile as VCFileCodeModel
    vcFile = DTE.Solution.Item(1).ProjectItems.Item(1).FileCodeModel
    vcFile.AddInclude("""stdafx.h""", 0)
End Sub

.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.

Partager via