IVsSolution Interface

Provides top-level manipulation or maintenance of the solution.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
<GuidAttribute("7F7CD0DB-91EF-49DC-9FA9-02D128515DD4")> _
<InterfaceTypeAttribute()> _
Public Interface IVsSolution

[GuidAttribute("7F7CD0DB-91EF-49DC-9FA9-02D128515DD4")]
[InterfaceTypeAttribute()]
public interface IVsSolution

[GuidAttribute(L"7F7CD0DB-91EF-49DC-9FA9-02D128515DD4")]
[InterfaceTypeAttribute()]
public interface class IVsSolution

[<GuidAttribute("7F7CD0DB-91EF-49DC-9FA9-02D128515DD4")>]
[<InterfaceTypeAttribute()>]
type IVsSolution =  interface end

public interface IVsSolution

The IVsSolution type exposes the following members.

Methods

	Name	Description
	AddVirtualProject	Adds a type of virtual project that is not created by clicking Open Project on the New menu to open the solution.
	AddVirtualProjectEx	Assigns the original GUID to the project when it is recreated the next time the solution is opened.
	AdviseSolutionEvents	Establishes client notification of solution events.
	CanCreateNewProjectAtLocation	Determines whether a new project can be created at a given location.
	CloseSolutionElement	Programmatically closes a document, a project, or the entire solution.
	CreateNewProjectViaDlg	Controls options for the Create New Project dialog box.
	CreateProject	Creates or opens a project.
	CreateSolution	Creates a new solution.
	GenerateNextDefaultProjectName	This method obtains the default name for the next project in the solution (ProjectN).Generates the next default project name given a specific path.
	GenerateUniqueProjectName	Generates a unique project name, given a root project name.
	GetGuidOfProject	Returns the unique identifier for a project in the solution.
	GetItemInfoOfProjref	Obtains the required property for the specified project item reference.
	GetItemOfProjref	Returns a hierarchy and hierarchy item pair for the specified project reference string.
	GetProjectEnum	Returns an enumerator for all the projects in the solution.
	GetProjectFactory	Returns a project factory.
	GetProjectFilesInSolution	Compiles a list of the specified projects in the solution.
	GetProjectInfoOfProjref	Obtains the required property for the specified project reference.
	GetProjectOfGuid	Returns the project in the solution, given a unique identifier.
	GetProjectOfProjref	Returns a hierarchy for the specified project reference string.
	GetProjectOfUniqueName	Returns the project in the solution, given a unique name.
	GetProjectTypeGuid	Returns the project type, given a GUID.
	GetProjrefOfItem	Returns a project reference string for the specified hierarchy and hierarchy item pair.
	GetProjrefOfProject	Returns a project reference string for the specified hierarchy.
	GetProperty	Returns the specified property of the solution.
	GetSolutionInfo	Returns the required solution file information.
	GetUniqueNameOfProject	Returns the unique name, given a project in the solution.
	GetVirtualProjectFlags	Determines how the virtual project was added to the Solution Explorer.
	OnAfterRenameProject	Completes the renaming of a project.
	OpenSolutionFile	Opens a solution file of the type .sln, .dsw, or .vbg.
	OpenSolutionViaDlg	Controls options for the Open Solution dialog box.
	QueryEditSolutionFile	Determines whether the solution file can be changed.
	QueryRenameProject	Determines whether the project can be renamed.
	RemoveVirtualProject	Removes a virtual project from the solution.
	SaveSolutionElement	Programmatically saves a document, a project, or the entire solution.
	SetProperty	Generically sets properties of the solution.
	UnadviseSolutionEvents	Disables a client from receiving notifications of solution events.

Top

Remarks

A project reference is a string value that is used as a unique project identifier and that is independent of which solution uses the project. The project reference is composed of the following:

• Path

• Project name

• Project type

• Project GUID

• Project type GUID

Each __VSPROPID must return a VARIANT structure filled with the proper VT_ type. The caller may assume that the VT_ is correct; that there is no need to call VariantChangeType, or to verify the type, beyond an ASSERT to make sure there weren't header file mismatches and related problems.

This same logic applies to the caller when setting the property. The solution will assume that the caller has passed a VARIANY already converted to the proper VT_ type.

Notes to Callers

Called to manage solutions. IVsSolution is implemented by the environment through the SVsSolution service.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace