VCCodeModel.AddImport(String, Object, Object, String) Method

Definition

Namespace:

Microsoft.VisualStudio.VCCodeModel

Assembly:

Microsoft.VisualStudio.VCCodeModel.dll

Adds a #import element to a specific file.

Microsoft::VisualStudio::VCCodeModel::VCCodeImport AddImport(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Location, winrt::Windows::Foundation::IInspectable const & Position, std::wstring const & Attributes = "");

[System.Runtime.InteropServices.DispId(569)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeImport AddImport (string Name, object Location, object Position, string Attributes = "");

[<System.Runtime.InteropServices.DispId(569)>]
abstract member AddImport : string * obj * obj * string -> Microsoft.VisualStudio.VCCodeModel.VCCodeImport

Public Function AddImport (Name As String, Location As Object, Optional Position As Object, Optional Attributes As String = "") As VCCodeImport

Parameters

Name

String

Required. Specifies the name (in quotes or between angle brackets <>) of the type library being imported.

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 AddImport(String, Object, Object, String) 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.

Attributes

String

Optional. One or more #import attributes. For a complete list, see the #import Attributes section of The #import Directive. Separate attributes with either a space or comma.

Returns

VCCodeImport

A VCCodeImport object.

Attributes

DispIdAttribute

Examples

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

Sub AddImport()  
    Dim codeModel As VCCodeModel  
    codeModel = DTE.Solution.Item(1).CodeModel  
    Dim import As VCCodeImport  
    import = codeModel.AddImport("""MyDll.dll""", "stdafx.h", -1, "no_namespace named_guids raw_interfaces_only")  
End Sub  

Remarks

Call this function to insert a #import element into the specified file contained by 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.