ReinstallAgreementLicenseKeyPack method of the Win32_TSLicenseKeyPack class
Reinstalls a Remote Desktop Services license key pack that was purchased through a license agreement, and automatically connects over the Internet to validate the key pack license.
Syntax
uint32 ReinstallAgreementLicenseKeyPack(
[in] uint32 AgreementType,
[in] string sAgreementNumber,
[in] uint32 ProductVersion,
[in] uint32 ProductType,
[in] uint32 LicenseCount,
[out] uint32 KeyPackId
);
Parameters
-
AgreementType [in]
-
Agreement type.
-
0
-
The license key pack is from a Select volume license agreement (for customers with 250 or more computers). The sAgreementNumber parameter is the enrollment number (seven numeric digits) found on the signed agreement form.
-
1
-
The license key pack is from an Enterprise volume license agreement for customers with 250 or more computers. The sAgreementNumber parameter is the enrollment number (seven numeric digits) found on the signed agreement form.
-
2
-
The license key pack is from a Campus volume license agreement for a higher education institution. The sAgreementNumber parameter is the enrollment number (seven numeric digits) found on the signed agreement form.
-
3
-
The license key pack is from a School volume license agreement for primary and secondary institutions. The sAgreementNumber parameter is the enrollment number (seven numeric digits) found on the signed agreement form.
-
4
-
The license key pack is from a Service Provider license agreement for service providers to license Microsoft software on a monthly basis. The sAgreementNumber parameter is the enrollment number (seven numeric digits) found on the signed agreement form.
-
5
-
The license key pack is from another license agreement, such as Open Value, Multi-Year Open License, and Open Subscription License. The sAgreementNumber parameter is the agreement number provided with your program information.
sAgreementNumber [in]
Agreement number or enrollment number. The sAgreementNumber parameter is a seven digit numeric string without hyphens.
ProductVersion [in]
Product version.
0
Not supported.
1
Not supported.
2
Windows Server 2008
ProductType [in]
Product type.
0
The Remote Desktop Services license key pack product type is per device. Therefore, each device that connects to the RD Session Host server must have a license.
1
The Remote Desktop Services license key pack product type is per user. Therefore, each user who connects to the RD Session Host server must have a license.
2
This product type is not valid.
LicenseCount [in]
Number of licenses to install.
KeyPackId [out]
Receives the key pack identifier.
Return value
If the method succeeds, it returns zero. If the method is unsuccessful, it returns a nonzero value. For a list of error codes, see Remote Desktop Services WMI Provider Error Codes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\CIMv2 |
| MOF |
|
| DLL |
|