VCProject.AddActiveXReference(String, Int32, Int32, Int32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.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 an ActiveX (COM) reference to the project.

public:
 System::Object ^ AddActiveXReference(System::String ^ typeLibGuid, int majorVersion, int minorVersion, int localeID, System::String ^ wrapper);

public:
 Platform::Object ^ AddActiveXReference(Platform::String ^ typeLibGuid, int majorVersion, int minorVersion, int localeID, Platform::String ^ wrapper);

winrt::Windows::Foundation::IInspectable AddActiveXReference(std::wstring const & typeLibGuid, int majorVersion, int minorVersion, int localeID, std::wstring const & wrapper);

[System.Runtime.InteropServices.DispId(842)]
public object AddActiveXReference (string typeLibGuid, int majorVersion, int minorVersion, int localeID, string wrapper);

[<System.Runtime.InteropServices.DispId(842)>]
abstract member AddActiveXReference : string * int * int * int * string -> obj

Public Function AddActiveXReference (typeLibGuid As String, majorVersion As Integer, minorVersion As Integer, localeID As Integer, wrapper As String) As Object

Parameters

typeLibGuid: String

A string representing the type library GUID.

majorVersion: Int32

An integer representing the major version number.

minorVersion: Int32

An integer representing the minor version number.

localeID: Int32

An integer representing the locale id.

wrapper: String

A string representing the wrapper name. Can be blank.

Returns

Object

An object representing the project reference.

Attributes: DispIdAttribute

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

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."

Applies to