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)

[GuidAttribute("FCC03D95-7C2E-4398-AAAE-0F4B56104FC8")]
[InterfaceTypeAttribute(1)]
public interface IVsOutputGroup

NameDescription
System_CAPS_pubmethodget_CanonicalName(String)

Returns the canonical name of the output group.

System_CAPS_pubmethodget_DeployDependencies(UInt32, IVsDeployDependency[], UInt32[])

Provides access to one or more deployment dependencies.

System_CAPS_pubmethodget_Description(String)

Returns the description of an output group.

System_CAPS_pubmethodget_DisplayName(String)

Returns the display name of the output group.

System_CAPS_pubmethodget_KeyOutput(String)

Returns the canonical name of the key output group.

System_CAPS_pubmethodget_Outputs(UInt32, IVsOutput2[], UInt32[])

Returns an array of pointers to IVsOutput2 interfaces providing access to a configuration's output items.

System_CAPS_pubmethodget_ProjectCfg(IVsProjectCfg2)

Returns a pointer to the configuration's IVsProjectCfg2 interface.

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 and .385fd2a3-d9f1-4808-87c2-a3f05a91fc36cccbaa9b-1d34-4e17-82b2-b4670d6f2577

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.

Return to top
Show: