VCFileCodeModel.AddIDLImport Method

Article
10/10/2013

Adds a new import statement to the .idl file of the VCFileCodeModel object.

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

Syntax

'Declaration
Function AddIDLImport ( _
    Name As String, _
    Position As Object _
) As VCCodeIDLImport

VCCodeIDLImport AddIDLImport(
    string Name,
    Object Position
)

VCCodeIDLImport^ AddIDLImport(
    String^ Name, 
    Object^ Position
)

abstract AddIDLImport : 
        Name:string * 
        Position:Object -> VCCodeIDLImport

function AddIDLImport(
    Name : String, 
    Position : Object
) : VCCodeIDLImport

Parameters

Name
Type: System.String

Required. Specifies the name (in quotes) of the header, IDL, or ODL file to be imported.

Position
Type: System.Object

Optional. 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.VCCodeIDLImport
A VCCodeIDLImport object.

Remarks

Call this function to insert an import statement into the.idl file of 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 imports the MyIdlFile.idl file into the .idl file of vcFile.

Sub AddIDLImport()
    Dim vcFile as VCFileCodeModel
    vcFile = DTE.Solution.Item(1).ProjectItems.Item(1).FileCodeModel
    vcFile.AddIDLImport("""MyIdlFile.idl""")
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