install

Interface Information

>This API belongs to SentinelLicensing.dll.

>The corresponding library is Sentinel RMS licensing library.

Description

>Installs the license in the following scenarios:

•In the case of network licensing, the license is installed on the License Manager.

•In the case standalone licensing, the license is installed on a standalone system.

•In the case of commuter licensing, the commuter authorization is installed on an end-user system.

>Installs the Acknowledgment string, generated using the sntl_licensing_transfer API, to return a commuter license. The License Manager reclaims the token after the installation of the Acknowledgment string.

>Installs the Base64 encoded Permission Ticket (named as the License Revocation Request or LRR). Also, returns the Base64 encoded Revocation Ticket (named as the License Revocation Acknowledgement or LRA) as a part of the license revocation workflow (described in the diagram below).

NOTE   Use sntl_licensing_install API instead of sntl_licensing_install_license, as it is deprecated since the v9.2.0.

Syntax

Void install (String installData);
String install (String installData, Attribute attribute);

Parameters

Parameter	Description
installData [in]	Use this parameter to specify the installation data such as the: >License string for license installation. >Acknowledgment string for returning a commuter license. >License Revocation Request (LRR). It must be Base64 encoded.
attribute [in]	Reserved for future use. Use NULL as the value for this argument.

Returns

If an LRR was specified using the installData parameter, this parameter returns the LRA. The LRA is encoded with Base 64. Decode it (from Base 64) before verification.

Exception Handling

If unsuccessful, throws LicensingException.