ProvideLoadKeyAttribute.Register Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Provides registration information about a VSPackage when called by an external registration tool such as regpkg.exe.

public:
 override void Register(Microsoft::VisualStudio::Shell::RegistrationAttribute::RegistrationContext ^ context);

 override void Register(Microsoft::VisualStudio::Shell::RegistrationAttribute::RegistrationContext const & context);

public override void Register (Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext context);

override this.Register : Microsoft.VisualStudio.Shell.RegistrationAttribute.RegistrationContext -> unit

Public Overrides Sub Register (context As RegistrationAttribute.RegistrationContext)

Parameters

context

RegistrationAttribute.RegistrationContext

A registration context provided by an external registration tool. The context can be used to create registry keys, log registration activity, and obtain information about the component being registered.

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.

The context contains the location where the registration information should be placed. It also contains such information as the type being registered, and the path information.

This method is called both for registration and unregistration. The difference is that unregistering just uses a hive that reverses the changes applied to it.

VSPackages that implement the ProvideLoadKeyAttribute class do not need to call the Register method. Register is called by the registration tools.