VCProject.AddActiveXReference Method

Article
09/26/2011

Adds an ActiveX (COM) reference to the project.

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

Syntax

'Declaration
Function AddActiveXReference ( _
    typeLibGuid As String, _
    majorVersion As Integer, _
    minorVersion As Integer, _
    localeID As Integer, _
    wrapper As String _
) As Object

Object AddActiveXReference(
    string typeLibGuid,
    int majorVersion,
    int minorVersion,
    int localeID,
    string wrapper
)

Object^ AddActiveXReference(
    [InAttribute] String^ typeLibGuid, 
    [InAttribute] int majorVersion, 
    [InAttribute] int minorVersion, 
    [InAttribute] int localeID, 
    [InAttribute] String^ wrapper
)

abstract AddActiveXReference : 
        typeLibGuid:string * 
        majorVersion:int * 
        minorVersion:int * 
        localeID:int * 
        wrapper:string -> Object

function AddActiveXReference(
    typeLibGuid : String, 
    majorVersion : int, 
    minorVersion : int, 
    localeID : int, 
    wrapper : String
) : Object

Parameters

typeLibGuid
Type: System.String
A string representing the type library GUID.

majorVersion
Type: System.Int32
An integer representing the major version number.

minorVersion
Type: System.Int32
An integer representing the minor version number.

localeID
Type: System.Int32
An integer representing the locale id.

wrapper
Type: System.String
A string representing the wrapper name. Can be blank.

Return Value

Type: System.Object
An object representing the project reference.

Remarks

One way to obtain the parameters for this method is to add the desired reference to your project, save the project, and then examine its .vcxproj file. The parameters are listed under "ActiveXReference."

Examples

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

AddActiveXReference adds an ActiveX type library reference to your project based on the parameters that you supply, if it is possible.

Imports EnvDTE
Imports System.Diagnostics
Imports Microsoft.VisualStudio.VCProjectEngine

Public Module Module1
    Sub Test()
        Dim prj As VCProject
        Dim tlguid, wrapper As String
        Dim majver, minver, lcid As Integer

        ' Add the following values:
        ' tlguid = The guid for the EnvDTE COM type library.
        ' wrapper = The wrapper name for EnvDTE, taken from .vcxproj file.
        ' majver, minver = The major and minor versions of DTE, 
        '                  taken from the .vcxproj file.
        ' lcid = The localization ID. 1033 is English. 
        '        Each language has its own LCID.
        tlguid = "{80CC9F66-E7D8-4DDD-85B6-D9E6CD0E93E2}"
        wrapper = "primary"
        majver = 7
        minver = 0
        lcid = 1033
        prj = DTE.Solution.Projects.Item(1).Object
        If prj.CanAddActiveXReference(tlguid, majver, minver, lcid, _
          wrapper) Then
            prj.AddActiveXReference(tlguid, majver, minver, lcid, wrapper)
        Else
            MsgBox("Cannot add the specified ActiveX typelib reference.")
        End If
    End Sub
End Module

.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