Share via


IVsOutputGroup Interface

Allows projects to group outputs according to usage.

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

Syntax

'Declaration
<GuidAttribute("FCC03D95-7C2E-4398-AAAE-0F4B56104FC8")> _
<InterfaceTypeAttribute()> _
Public Interface IVsOutputGroup
[GuidAttribute("FCC03D95-7C2E-4398-AAAE-0F4B56104FC8")]
[InterfaceTypeAttribute()]
public interface IVsOutputGroup
[GuidAttribute(L"FCC03D95-7C2E-4398-AAAE-0F4B56104FC8")]
[InterfaceTypeAttribute()]
public interface class IVsOutputGroup
[<GuidAttribute("FCC03D95-7C2E-4398-AAAE-0F4B56104FC8")>]
[<InterfaceTypeAttribute()>]
type IVsOutputGroup =  interface end
public interface IVsOutputGroup

The IVsOutputGroup type exposes the following members.

Methods

  Name Description
Public method get_CanonicalName Returns the canonical name of the output group.
Public method get_DeployDependencies Provides access to one or more deployment dependencies.
Public method get_Description Returns the description of an output group.
Public method get_DisplayName Returns the display name of the output group.
Public method get_KeyOutput Returns the canonical name of the key output group.
Public method get_Outputs Returns an array of pointers to IVsOutput2 interfaces providing access to a configuration's output items.
Public method get_ProjectCfg Returns a pointer to the configuration's IVsProjectCfg2 interface.

Top

Remarks

Grouping output items allows project configurations to categorize by usage. For example, a DLL file might be grouped with its PDB file. The project must return the same number of groups for each configuration that it supports, even though the number of outputs contained within a group might vary from configuration to configuration. For example, the group "Matt's DLL" might include mattd.dll and mattd.pdb in debug configuration, but only include matt.dll in retail configuration.

Groups may also have a key output that allows packaging shortcuts to point to something meaningful. Any group might be empty in a given configuration, so no assumptions should be made about the size of a group.

If a project has an IVsOutput2 object that it does not want to package or deploy, it is sufficient to not put that output in a group.

Callers can access a configuration's output groups by calling get_OutputGroups or OpenOutputGroup.

See illustrations of the implementation and/or calling of this interface in the samples Basic Project and My C Package.

Notes to Implementers

Implemented by project configurations that organize their output items into groups by usage.

Notes to Callers

Called by the environment and deployment projects during deployment operations.

These groups will also have the same identifier information (canonical name, display name, and group information) from one configuration to another within a project. This allows deployment and packaging to continue to operate even if configurations change.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace