ProvideLoadKeyAttribute Constructor (String^, String^, String^, String^, Int16)

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

public:
ProvideLoadKeyAttribute(
	String^ minimumEdition,
	String^ productVersion,
	String^ productName,
	String^ companyName,
	short resourceId
)

Parameters

minimumEdition
Type: System::String^

The minimum edition of Visual Studio on which the VSPackage is loaded. This must be the literal edition value provided by Microsoft when obtaining your Package Load Key (PLK).

productVersion
Type: System::String^

The version of the product that this VSPackage implements.

productName
Type: System::String^

Name of the product that this VSPackage delivers. Products comprised of multiple VSPackages each need their own PLK.

companyName
Type: System::String^

VSIP Partner/creator of the VSPackage. Must exactly match the name you provided to Microsoft when you registered for a PLK. companyName is case-sensitive.

resourceId
Type: System::Int16

Resource ID for VSPackage load key.

Exception Condition
ArgumentNullException

minimumEdition, productVersion, productName or companyName are null.

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.

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.

The following Visual C# code applies the ProvideLoadKey attribute to a VSPackage named MyVSPackage.

using Microsoft.VisualStudio.Shell;
using MSVSIP = Microsoft.VisualStudio.Shell;
[MSVSIP.ProvideLoadKey(typeof(MyObject))]
public class MyVSPackage : MSVSIP.Package {}
Return to top
Show: