MsiComponentIdAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

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.

This attribute defines the MSI component ID that is used by the MSI installer. This component ID is used to indicate the install path to this component. This must be placed on a package class if the package is to be installed by MSI.

public ref class MsiComponentIdAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)]
public sealed class MsiComponentIdAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)>]
type MsiComponentIdAttribute = class
    inherit Attribute

Public NotInheritable Class MsiComponentIdAttribute
Inherits Attribute

Inheritance: Attribute
MsiComponentIdAttribute

Attributes: AttributeUsageAttribute

Remarks

When to Call

Apply this attribute to a Package-derived class or one that implements IVsPackage when you use the Windows Installer to install your VSPackage.

Basic Usage

MsiComponentIdAttribute defines the Microsoft Windows Installer component ID. The component ID is used by the Windows Installer to indicate the installation path to the component.

This attribute class is only used to provide data for external registration tools like regpkg.exe. It does not have any effect on the runtime behavior of the VSPackage. For more information, see Registering VSPackages.

Note

Visual C# automatically appends the word "Attribute" to the name of any attribute class. In Visual C# code, refer to this attribute as MsiComponentId.

Constructors

MsiComponentIdAttribute(String)

Creates a new MsiComponentIdAttribute.

Properties

Id	Returns the component registration ID.

Applies to