ProvideLoadKeyAttribute Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class ProvideLoadKeyAttribute _
    Inherits RegistrationAttribute

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

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

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)>]
type ProvideLoadKeyAttribute =  
    class 
        inherit RegistrationAttribute 
    end

public final class ProvideLoadKeyAttribute extends RegistrationAttribute

The ProvideLoadKeyAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideLoadKeyAttribute	Creates a new ProvideLoadKeyAttribute.

Top

Properties

	Name	Description
	CompanyName	Gets the company name.
	MinimumEdition	Gets the minimum edition of Visual Studio needed to load your VSPackage.
	ProductName	Gets the name of your VSPackage.
	ProductVersion	Gets the version number of your VSPackage.
	ResourceId	Gets the resource ID for the Package Load Key.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	Register	Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	RegKeyName	Returns the registry key name for this package's load key information.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes the registration information about a VSPackage when called by an external registration tool such as regpkg.exe. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

Important

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.

Note

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

When to Call

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.

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.Shell Namespace