References.AddProject(Project) Method

Reference

Definition

Namespace:: VSLangProj

Assembly:: VSLangProj.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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 a new project reference to the project and returns the newly created Reference object.

public:
 VSLangProj::Reference ^ AddProject(EnvDTE::Project ^ pProject);

public:
 VSLangProj::Reference ^ AddProject(EnvDTE::Project ^ pProject);

VSLangProj::Reference AddProject(EnvDTE::Project const & pProject);

[System.Runtime.InteropServices.DispId(8)]
public VSLangProj.Reference AddProject (EnvDTE.Project pProject);

[<System.Runtime.InteropServices.DispId(8)>]
abstract member AddProject : EnvDTE.Project -> VSLangProj.Reference

Public Function AddProject (pProject As Project) As Reference

Parameters

pProject: Project

Required. The Project object to be added.

Returns

Reference

Attributes: DispIdAttribute

Examples

' Macro Editor      
Imports VSLangProj  
' Add the second project as a reference to the first project.  
Sub AddProjectExample()  
   ' First project is a Visual Basic or C# project.  
   Dim theVSProject As VSProject = _  
      CType(DTE.Solution.Projects.Item(1).Object, VSProject)  

   ' Second project is any type of project.  
   Dim secondProject As Project = DTE.Solution.Projects.Item(2)  

   ' AddProject returns the newly created Reference object.  
   Dim newReference As Reference  
   newReference = theVSProject.References.AddProject(secondProject)  
End Sub

Remarks

This method does not generate an error if a reference exists in the project with the same Identity, Culture, MajorVersion, MinorVersion, BuildNumber, and RevisionNumber as the new reference. That condition would indicate that the reference indicated by the bstrPath parameter has already been added to the project. Instead, the ProjectItem for the matching reference already in the project is returned.

If a reference with the same Identity but differing MajorVersion, MinorVersion, BuildNumber, RevisionNumber or Culture is found in the project, the method generates an error.

Applies to

Share via