uninstall Supported in On-premises mode

Interface Information

>This API belongs to SentinelLicensing.dll.

>The corresponding library is Sentinel RMS licensing library.

Description

Deletes a license from the designated License Manager’s memory and license file. It is useful in scenarios when you want to delete the obsolete or expired licenses from both the License Manager’s memory and file.

NOTE   The license deletion fails, if the license is in use or is of redundant type.

Syntax

String uninstall(String uninstallData)

Parameters

Parameter Description
uninstallData [in]

Information about the data that needs to be removed.

It can contain a license hash and / or license string to identify a specific license. If the input contains information about license hash and license, preference is given to the license. The format of the input XML is described below: 

<uninstallData>
   <licenseHash> </licenseHash>
   <license> </license>
 </uninstallData>

NOTE   You can obtain the license hash using the licenseInfo query of the getInfo API for licenses already installed on the License Manager.

Returns

License hash of the license removed. It may contain the license (string) as well, except when the license is not available in the license file.

The format of the output XML is described below:

<uninstallData>
   <licenseHash> </licenseHash>
   <license> </license>
</uninstallData>

Exception Handling

If unsuccessful, throws LicensingException.