VCCodeModel.AddIDLImport(String, Object, Object) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCCodeModel

Assembly:: Microsoft.VisualStudio.VCCodeModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds a new import statement to a specific .idl file.

Microsoft::VisualStudio::VCCodeModel::VCCodeIDLImport AddIDLImport(std::wstring const & Name, winrt::Windows::Foundation::IInspectable const & Location, winrt::Windows::Foundation::IInspectable const & Position);

[System.Runtime.InteropServices.DispId(571)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeIDLImport AddIDLImport (string Name, object Location, object Position);

[<System.Runtime.InteropServices.DispId(571)>]
abstract member AddIDLImport : string * obj * obj -> Microsoft.VisualStudio.VCCodeModel.VCCodeIDLImport

Public Function AddIDLImport (Name As String, Location As Object, Optional Position As Object) As VCCodeIDLImport

Parameters

Name: String

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

Location: Object

Required. The path or file name of the .idl 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 AddIDLImport(String, Object, Object) fails.

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

Returns

VCCodeIDLImport

A VCCodeIDLImport object.

Attributes: DispIdAttribute

Examples

This example adds an import statement to the Project.idl file.

Sub AddIDLImport()  
    Dim codeModel As VCCodeModel  
    codeModel = DTE.Solution.Item(1).CodeModel  
    Dim idlImport As VCCodeIDLImport  
    idlImport = codeModel.AddIDLImport("""MyIdlFile.idl""", "Project.idl")  
End Sub

Remarks

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

Applies to