ProvideLoadKeyAttribute Class

 

This attribute provides a package load key for your package. Not needed in Visual Studio 2010.

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

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideLoadKeyAttribute

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, 
	AllowMultiple = false)]
public sealed class ProvideLoadKeyAttribute : RegistrationAttribute

NameDescription
System_CAPS_pubmethodProvideLoadKeyAttribute(String, String, String, String, Int16)

Creates a new ProvideLoadKeyAttribute.

NameDescription
System_CAPS_pubpropertyCompanyName

Gets the company name.

System_CAPS_pubpropertyMinimumEdition

Gets the minimum edition of Visual Studio needed to load your VSPackage.

System_CAPS_pubpropertyProductName

Gets the name of your VSPackage.

System_CAPS_pubpropertyProductVersion

Gets the version number of your VSPackage.

System_CAPS_pubpropertyResourceId

Gets the resource ID for the Package Load Key.

System_CAPS_pubpropertyTypeId

Gets the current instance of this attribute.(Inherited from RegistrationAttribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodRegister(RegistrationAttribute.RegistrationContext)

Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)

System_CAPS_pubmethodRegKeyName(RegistrationAttribute.RegistrationContext)

Returns the registry key name for this package's load key information.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUnregister(RegistrationAttribute.RegistrationContext)

Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

System_CAPS_importantImportant

Packages that target Visual Studio 2010 only do not need a package load key.

Packages that target Visual Studio 2008 and earlier must have a package load key in order to validate and load VSPackages. This includes VSPackages provided by third parties, regardless of whether the hosting version of Visual Studio has a VSIP license.

Developers can load their own VSPackages without package load key if they have a valid VSIP developer license.

This attribute class is used only 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.

System_CAPS_noteNote

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

For VSPackages that target Visual Studio 2008 and earlier, apply this attribute to your Package-derived class or class that implements IVsPackage to define its package load key. A package load key is used by Visual Studio to validate that a package can be loaded.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: