Partager via


ProvideLoadKeyAttribute Class

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

Namespace:  Microsoft.VisualStudio.Shell
Assemblies:   Microsoft.VisualStudio.Shell.9.0 (in Microsoft.VisualStudio.Shell.9.0.dll)
  Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
  Microsoft.VisualStudio.Shell (in Microsoft.VisualStudio.Shell.dll)

Syntax

'Déclaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class ProvideLoadKeyAttribute _
    Inherits RegistrationAttribute
'Utilisation
Dim instance As ProvideLoadKeyAttribute
[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
[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = false)>]
type ProvideLoadKeyAttribute =  
    class
        inherit RegistrationAttribute
    end
public final class ProvideLoadKeyAttribute extends RegistrationAttribute

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.

Notes

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.

Inheritance Hierarchy

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

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

ProvideLoadKeyAttribute Members

Microsoft.VisualStudio.Shell Namespace