VCFileCodeModel.AddImport Method

Article
10/10/2013

Adds a #import element to the VCFileCodeModel object.

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

Syntax

'Declaration
Function AddImport ( _
    Name As String, _
    Position As Object, _
    Alias As String _
) As CodeImport

CodeImport AddImport(
    string Name,
    Object Position,
    string Alias
)

CodeImport^ AddImport(
    String^ Name, 
    [InAttribute] Object^ Position, 
    [InAttribute] String^ Alias
)

abstract AddImport : 
        Name:string * 
        Position:Object * 
        Alias:string -> CodeImport

function AddImport(
    Name : String, 
    Position : Object, 
    Alias : String
) : CodeImport

Parameters

Name
Type: System.String

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

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.

Alias
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: EnvDTE80.CodeImport
A CodeImport object.

Remarks

Call this function to insert a #import 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 #import statement to the file represented by the vcFile object.

Sub AddImport()
    Dim vcFile as VCFileCodeModel
    vcFile = DTE.Solution.Item(1).ProjectItems.Item(1).FileCodeModel
    vcFile.AddImport("""MyDll.dll""", 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