VCCodeModel.AddImport Method

  • Article

Adds a #import element to a specific file.

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

Syntax

'Declaration
Function AddImport ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Attributes As String _
) As VCCodeImport

VCCodeImport AddImport(
    string Name,
    Object Location,
    Object Position,
    string Attributes
)

VCCodeImport^ AddImport(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    String^ Attributes
)

abstract AddImport : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Attributes:string -> VCCodeImport

function AddImport(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Attributes : String
) : VCCodeImport

Parameters

  • Name
    Type: System.String

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

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

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

Return Value

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

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.

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

.NET Framework Security

See Also

Reference

VCCodeModel Interface

Microsoft.VisualStudio.VCCodeModel Namespace