VCCodeModel.AddIDLLibrary Method

  • Article

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

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

Syntax

'Declaration
Function AddIDLLibrary ( _
    Name As String, _
    Location As Object, _
    Position As Object _
) As VCCodeIDLLibrary

VCCodeIDLLibrary AddIDLLibrary(
    string Name,
    Object Location,
    Object Position
)

VCCodeIDLLibrary^ AddIDLLibrary(
    String^ Name, 
    Object^ Location, 
    Object^ Position
)

abstract AddIDLLibrary : 
        Name:string * 
        Location:Object * 
        Position:Object -> VCCodeIDLLibrary

function AddIDLLibrary(
    Name : String, 
    Location : Object, 
    Position : Object
) : VCCodeIDLLibrary

Parameters

  • Name
    Type: String

    Required. Specifies the name of the new library.

  • Location
    Type: 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 fails.

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

Return Value

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

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.

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

.NET Framework Security

See Also

Reference

VCCodeModel Interface

Microsoft.VisualStudio.VCCodeModel Namespace