sntl_licensing_get_info
Library Information
>This API belongs to the Sentinel RMS licensing library.
>The corresponding header is licensing.h.
Description
NOTE From RMS v9.5 onwards, query version 1.1 has been introduced to support license hard limit up to 4,294,967,294. This is applicable to license version 20 and above. The SNTL_QUERY_XXXX_XXXX_LATEST macro is introduced to extract the latest version for any of the query types. Refer to licensing.h (included with your Sentinel RMS installation) for the exact macro name.
Version Compatibility
Prior to Sentinel RMS v9.5, you had to manually enter the query version at the time of compiling the application. For example, SNTL_QUERY_FEATURE_INFO_VERSION(v); where 'v' represents the query version for the installed SDK.
From Sentinel RMS v9.5 onwards, we have introduced macros for automating this task. When the application is compiled, it automatically takes the latest query version from the header file that is used. For example, for the license info query, when you compile your application using the SNTL_QUERY_LICENSE_INFO_LATEST macro, the latest query version is automatically entered by the application.
| Argument | Description |
|---|---|
| app_context [in] | Pointer to the application context object. |
| scope [in] | Search/filter parameters for the query. |
| query [in] |
Type of query. See Query Types in the table below. |
| info [out] |
The information returned for the query. Memory resources are allocated by the API and can be released using the sntl_licensing_free API. |
Click any of the following query type links to learn about the corresponding XML query, scope, and output.
| Query Types | Versions* | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
appContextInfo   
|
1.0 | The information about the various attributes set in an application context. | ||||||||||
| clientInfo
|
1.0, 1.1 | The information about a client using a given license. Query version 1.1 has been introduced to support license hard limit up to 4,294,967,294. This is applicable to RMS v9.5 and license version 20 (or above). | ||||||||||
| featureCumulativeTrialInfo
|
1.0 | The cumulative information about the trial period of trial licenses for the given feature. | ||||||||||
|
|
1.0, 1.1 | The information about the given feature obtained from the feature node. Query version 1.1 has been introduced to support license hard limit up to 4,294,967,294. This is applicable to RMS v9.5 and license version 20 (or above). | ||||||||||
|
|
1.0, 1.1 | The information about the given license from the license node. Query version 1.1 has been introduced to support license hard limit up to 4,294,967,294. This is applicable to RMS v9.5 and license version 20 (or above). | ||||||||||
|
1.0, 1.1
|
The available system fingerprint information of the supported locking criteria. The fingerprint information can be: >Hashed values - Hashed values are used for registering fingerprints in the Sentinel EMS Customer portal. To obtain hashed values, use the fingerprintInfo query version 1.0 or 1.1. >Raw values - Raw values are used for generating locking codes as required in Sentinel RMS traditionally (see lockCodeInfo query). To generate raw values: •Use the latest version 1.1 of the fingerprintInfo query, introduced in v9.2.0. •Set the <rawValue> tag in the query as Yes. |
|||||||||||
| libraryInfo
|
1.0 | The information about the licensing library. | ||||||||||
| lockCodeInfo
|
1.0 |
Introduced in v9.2.0, the lockCodeInfo query allows generation of locking codes. The locking code can be generated for the following: >Specific machine - Specify the fingerprint XML of the target system under lockCodeInfo scope XML . >The current system - If the fingerprint XML is not provided, the locking code is generated by fetching the fingerprints of the given system. For details, see Case A and Case B in
NOTE If multiple instances of a locking criteria are present on a system, the locking code is generated for the first instance only, without enumerating through other instances. For example, if a system has multiple Ethernet cards, locking code is generated for the value available at the first index of the |
||||||||||
| recipientInfo
|
1.0 |
The locking information of the recipient machine is obtained for use with the sntl_licensing_transferAPI (the commute action). The recipient machine is the one to which a license that has been detached from a network pool on the License Manager host is temporarily made available. |
||||||||||
| serverInfo
|
1.0 | The information about the License Manager. | ||||||||||
| serverPoolInfo
|
1.0 | The information about a group of License Managers hosting the same license for high availability. | ||||||||||
| syncLicenseJobInfo
|
1.0 |
This is applicable to the Lease mode only. Introduced in v9.2.0, the syncLicenseJobInfo query obtains information about current status of the lease job for standalone licenses.
|
||||||||||
| lastStatusInfo
|
1.0 |
Provides the status code and status message returned by the last-called Unified API, related to an application context.
This query type does not provide information for API calls that are not related to an application context. For example, sntl_licensing_configure. |
||||||||||
| statusInfo
|
1.0 |
Provides the status message corresponding to the given status code. NOTE Some status descriptions use feature name and contact server information at runtime. If this information is not available, this query type returns “Unknown” as the value for these fields in the message description. |
||||||||||
| usageInfo
|
1.0 | Provides the path where the completed license usage file and acknowledgment file is stored. |
* 1.0 is the default version.
Returns
The status code SNTL_SUCCESS is returned, if successful. Otherwise, an error code is returned indicating the reason for failure.
For the complete list of error codes, refer to Licensing Library Error and Result Codes.