VCProject.CanAddAssemblyReference(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.

Returns whether it is okay to add the given assembly (.NET) reference.

public:
 bool CanAddAssemblyReference(System::String ^ bstrRef);

public:
 bool CanAddAssemblyReference(Platform::String ^ bstrRef);

bool CanAddAssemblyReference(std::wstring const & bstrRef);

[System.Runtime.InteropServices.DispId(844)]
public bool CanAddAssemblyReference (string bstrRef);

[<System.Runtime.InteropServices.DispId(844)>]
abstract member CanAddAssemblyReference : string -> bool

Public Function CanAddAssemblyReference (bstrRef As String) As Boolean

Parameters

bstrRef: String

The assembly reference.

Returns

Boolean

true if whether it is okay to add the given assembly reference; false if not.

Attributes: DispIdAttribute

Examples

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

CanAddAssemblyReference adds a .NET assembly reference to your project based on the path to the assembly, if possible.

' Add a reference to Microsoft.VisualStudio.VCProjectEngine and have a   
' Visual C++ project loaded before running this example.  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  
Public Module Module1  
    Sub Test()  
        Dim prj As VCProject  
        Dim vcar As VCAssemblyReference  
        Dim refcfg As VCReferenceConfiguration  

        prj = DTE.Solution.Projects.Item(1).Object  
        If prj.CanAddAssemblyReference("C:\Program Files\ _  
        Microsoft Visual Studio 8\Common7\IDE\ _  
        PublicAssemblies\envdte.dll") Then  
           vcar = prj.AddAssemblyReference("C:\Program Files\ _  
           Microsoft Visual Studio 8\Common7\IDE\ _  
           PublicAssemblies\envdte.dll")  
        End If  
        refcfg = vcar.ReferenceConfigurations.Item(1)  
        MsgBox("Consumable? " & refcfg.ConsumableByDesigner)  
    End Sub  
End Module

Remarks

It would not be okay to add an assembly reference if, for example, you have an invalid GUID.

This method is generally used in tandem with the AddAssemblyReference method. You use this method to determine whether it is okay to add an assembly reference, and if it is, then you call AddAssemblyReference.

Applies to