VCProject.CanAddProjectReference Method

  • Article

Returns whether it is okay to add the given project reference

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

Syntax

'Declaration
Function CanAddProjectReference ( _
    proj As Object _
) As Boolean

bool CanAddProjectReference(
    Object proj
)

bool CanAddProjectReference(
    [InAttribute] Object^ proj
)

abstract CanAddProjectReference : 
        proj:Object -> bool

function CanAddProjectReference(
    proj : Object
) : boolean

Parameters

  • proj
    Type: Object

    The project reference.

Return Value

Type: Boolean
true if it is okay to add the given project reference; otherwise, false.

Remarks

This method is generally used in conjunction with the AddProjectReference method. You use this method to determine whether it is okay to add a project reference, and if it is, then you call AddProjectReference.

Examples

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

CanAddProjectReference adds a second project as a reference to the first project, if possible.

' Add a reference to Microsoft.VisualStudio.VCProjectEngine and have 
' two Visual C++ projects loaded before running this example.
Imports EnvDTE
Imports Microsoft.VisualStudio.VCProjectEngine
Public Module Module1
    Sub Test()
        Dim prj1, prj2 As VCProject
        prj1 = DTE.Solution.Projects.Item(1).Object
        prj2 = DTE.Solution.Projects.Item(2).Object
        ' Adds project 2 as a reference to project 1.
        If prj1.CanAddProjectReference(prj2) Then
            prj1.AddProjectReference(prj2)
        End If
    End Sub
End Module

.NET Framework Security

See Also

Reference

VCProject Interface

Microsoft.VisualStudio.VCProjectEngine Namespace