Compartilhar via


VCFileCodeModel.AddInclude(String, Object) Method

Definition

Adds a #include element to the VCFileCodeModel object.

Microsoft::VisualStudio::VCCodeModel::VCCodeInclude AddInclude(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Position);
[System.Runtime.InteropServices.DispId(567)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeInclude AddInclude (string Name, object Position);
[<System.Runtime.InteropServices.DispId(567)>]
abstract member AddInclude : string * obj -> Microsoft.VisualStudio.VCCodeModel.VCCodeInclude
Public Function AddInclude (Name As String, Optional Position As Object) As VCCodeInclude

Parameters

Name
String

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

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

Returns

A VCCodeInclude object.

Attributes

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  

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.

Applies to