VCFileCodeModel.AddIDLLibrary Method

Article
09/26/2011

Adds a new library 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 AddIDLLibrary ( _
    Name As String, _
    Position As Object _
) As VCCodeIDLLibrary

VCCodeIDLLibrary AddIDLLibrary(
    string Name,
    Object Position
)

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

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

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

Parameters

Name
Type: System.String
Required. Specifies the name of the new library.

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.VCCodeIDLLibrary
A VCCodeIDLLibrary object.

Remarks

Call this function to insert a library 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 adds a library statement to the .idl file of vcFile.

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

Share via