VCCodeModel.AddIDLLibrary(String, Object, Object) Method

Definition

Namespace:

Microsoft.VisualStudio.VCCodeModel

Assembly:

Microsoft.VisualStudio.VCCodeModel.dll

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

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

[System.Runtime.InteropServices.DispId(572)]
public Microsoft.VisualStudio.VCCodeModel.VCCodeIDLLibrary AddIDLLibrary (string Name, object Location, object Position);

[<System.Runtime.InteropServices.DispId(572)>]
abstract member AddIDLLibrary : string * obj * obj -> Microsoft.VisualStudio.VCCodeModel.VCCodeIDLLibrary

Public Function AddIDLLibrary (Name As String, Location As Object, Optional Position As Object) As VCCodeIDLLibrary

Parameters

Name

String

Required. Specifies the name of the new library.

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 AddIDLLibrary(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

VCCodeIDLLibrary

A VCCodeIDLLibrary object.

Attributes

DispIdAttribute

Examples

This example adds a library statement to the end of the Project.idl file.

Sub AddIDLLibrary()  
    Dim codeModel As VCCodeModel  
    codeModel = DTE.Solution.Item(1).CodeModel  
    Dim idlLibrary As VCCodeIDLLibrary  
    idlLibrary = codeModel.AddIDLLibrary("MyLibrary", "Project.idl", -1)  
End Sub  

Remarks

Call this function to insert a library 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.