Upgrade License API

The Sentinel RMS upgrade license feature enables you to update your customer's existing license to change the version or/and increase the capacity. A special upgrade license must be created to update the existing license.

NOTE   Upgrade license is not applicable in case of standalone environments.

The API functions discussed in this section are categorized into license code generator and decoder API.

Function	Description
VLSucgInitialize	Initializes the upgrade codegen library.
VLSucgCleanup	Cleanups the resources.
VLSucgReset	Sets all the fields of ucodeT to their default values.
VLSucgGetNumErrors	Identifies the total number of messages recorded in the handle.
VLSucgGetErrorLength	Returns the length of error message
VLSucgGetErrorMessage	Returns the earliest error from the handle up to bufLen characters
VLSucgPrintError	Prints all the error messages.
VLSucgAllowBaseFeatureName	Identifies whether the feature name should be called or not.
VLSucgSetBaseFeatureName	Sets the value of the base feature name.
VLSucgAllowBaseFeatureVersion	Identifies whether the feature version should be called or not.
VLSucgSetBaseFeatureVersion	Sets the value of base feature version in the ucodeT struct.
VLSucgAllowUpgradeCode	Identifies whether the corresponding VLSucgSetUpgradeCode should be called or not.
VLSucgSetUpgradeCode	Sets the value of the base locking code in the ucodeT struct.
VLSucgAllowUpgradeFlag	Identifies whether VLSucgSetUpgradeFlag should be called or not.
VLSucgSetUpgradeFlag	Sets the value of upd_flags in the ucodeT struct.
VLSucgAllowUpgradeVersion	Indicates whether the corresponding VLSucgSetUpgradeVersion should be called or not.
VLSucgSetUpgradeVersion	Sets the value of upd_version in the ucodeT struct.
VLSucgAllowUpgradeCapacity	Indicates whether the corresponding VLSucgSetUpgradeCapacityUnits and VLSucgSetUpgradeCapacity should be called or not.
VLSucgSetUpgradeCapacityUnits	Sets the value of capacity_units in the ucodeT struct.
VLSucgSetUpgradeCapacity	Sets the value of capacity_increment in the ucodeT struct.
VLSucgGenerateLicense	Generates the upgrade license for the given ucodeT struct.
VLSucgGetLicenseMeterUnits	Returns the number of license generation units available in the attached dongle.
VLSgenerateUpgradeLockCode	Generates a unique upgrade code for the base license.
VLSdecodeUpgradelockCode	Decodes the upgrade locking code.
VLSucgDecodeLicense	Decodes the encrypted license string generated by upgrade code generator library.