VLScleanStandalonePersistenceInfo
Description
The API function can be used for cleaning and/or repairing persistence information in the following standalone licensing scenarios.
The cleaning operation removes persistence information, whereas the repair operation fixes the corrupted data.
| Standalone Persistence Type |
Licensing Library Versions | |||||
|---|---|---|---|---|---|---|
| 9.7.0 (and later) | 9.4.0 (and later) | 9.3.0 (and later) | 8.2.x (and later) | 8.1.x | 8.0.x | |
| Trial | Repairing | Repairing | Repairing | Repairing | Repairing only | Cleaning |
| Commuter | Cleaning for Traditional API and Repairing only for Unified API | Cleaning for Traditional API and Repairing only for Unified API | Cleaning for Traditional API and Repairing only for Unified API |
Cleaning |
Cleaning | Cleaning |
| Time-tamper | Cleaning | Cleaning | Cleaning | Cleaning | Cleaning | Cleaning |
| Grace | Cleaning | Cleaning | Cleaning | Cleaning | Cleaning | Cleaning |
| Revocation (applies to Method 4)1 | Repairing | Repairing | Repairing | Repairing | NA | NA |
| Volume Transaction | Repairing | Repairing | Repairing | Repairing | NA | NA |
| Cancel Lease | Repairing | Repairing | NA | NA | NA | NA |
| Usage Data | Repairing | NA | NA | NA | NA | NA |
1 Method 4: License-string-based standalone revocation. For details about revocation methods, refer to the topic "Timeline of License Revocation Methods Available in RMS" in the Sentinel RMS Developer Guide.
Syntax
LS_STATUS_CODE VLScleanStandalonePersistenceInfo (
int clientLibVersion,
int persistenceType,
char* featureName,
char* featureVersion,
char* unused1,
int unused2 );| Argument | Direction | Data Type | Description |
|---|---|---|---|
| clientLibVersion | IN | int |
The licensing library's version used in the client application. It must be passed in the following format (without any space or delimiter): major version minor version patch version For example, >Pass "940" - For the v9.4.0 licensing library >Pass "855" - For the v8.5.5 licensing library >Pass "823" - For the v8.2.3 licensing library >Pass "700" - For the v7.0.0 licensing library In order to maintain backward compatibility, this API shall continue to accept the version as passed in the older convention (till 8.5.1). |
| persistenceType | IN | int |
Specify any of the following persistence types: >VLS_TRIAL_STORE >VLS_COMMUTER_STORE >VLS_REVOKE_STORE >VLS_GRACE_STORE >VLS_VTL_STORE >VLS_TIME_TAMPER_STORE >VLS_CANCEL_LEASE_STORE >VLS_USAGE_LOG_NONET_STORE >VLS_ROLLOVER_COUNT_STORE >VLS_USAGE_LOG_COMMON_STORE >VLS_USAGE_GUID_STORE |
| featureName | IN | char* |
The feature name of the license. Should not be of zero length and must not exceed 24 characters. |
| featureVersion | IN | char* |
The version of the license. Must not exceed 11 characters. The feature name and version parameters are optional for repairing operations in the following cases: >Trial license persistence (version 8.2.x or higher) >Time tamper persistence on Windows (version earlier than 8.0.x) >Time tamper persistence on UNIX, Android, and Linux ARM. >Standalone revocation persistence (version 8.2.x or higher) >Volume transaction license persistence (version 8.2.x or higher) >Cancel lease license persistence (version 9.4 or higher) >Usage log persistence (version 9.7 or higher) |
Call this API function with proper arguments to clean a particular persistence. No pre-processing (initialization) or post-processing (cleanup) is required.
NOTE To repair the corrupted cancel lease persistence files, client library version '940 or later' and persistence type '12' must be passed as input parameters to this API function.
Returns
The status code VLScl_SUCCESS is returned, if successful. Otherwise, any of the error codes listed here will be returned.