The LMX_GetFeatureInfo function retrieves information for a checked out feature.
Prototype
LMX_STATUS LMX_GetFeatureInfo
(
LMX_HANDLE LmxHandle,
const char *szFeatureName,
LMX_FEATURE_INFO *pFI
);
Parameters
LmxHandle
[in] LM-X handle.
szFeatureName
[in] Feature name.
pFI
[out] Pointer to the feature information structure. For more details, see the table of LMX_FEATURE_INFO fields in Remarks, below.
Return Values
On success, this function returns the status code LMX_SUCCESS.
On failure, this function returns an error code in the format described in Return codes.
Remarks
Use this API call to retrieve feature settings, as described in the following table. Note that trial licenses have substantially less information available than other license types, because they are a pre-configured license type and do not have the same flexibility.
LMX_FEATURE_INFO contains the following fields.
LMX_FEATURE_INFO field |
Description |
char szFeatureName[LMX_MAX_NAME_LENGTH] |
These strings contain the feature name and vendor name. The feature name is case-insensitive. |
char szStartDate[LMX_MAX_SHORT_STRING_LENGTH] |
These strings contain the start and expire date in format "YYYY-MM-DD". If no limitations are set, the strings will be empty. |
char szActualExpireTime[LMX_MAX_SHORT_STRING_LENGTH] |
This string contains the actual license expire time in format "YYYY-MM-DD HH:MM". |
char szMaintenanceStartDate[LMX_MAX_SHORT_STRING_LENGTH] |
These strings contain the start and expire date for optional maintenance in the format "YYYY-MM-DD". |
char szIssuedDate[LMX_MAX_SHORT_STRING_LENGTH] |
This string contains the license issue date in the format "YYYY-MM-DD" if specified in the license. |
char szPlatforms[LMX_MAX_SHORT_STRING_LENGTH] |
This field contains the platforms the license can be used with. |
char szComment[LMX_MAX_FIELD_LENGTH] |
This field contains the COMMENT string content of the license. |
char szData[LMX_MAX_FIELD_LENGTH] |
This field contains the DATA string content of the license. |
char szLicensee[LMX_MAX_FIELD_LENGTH] |
This field contains the LICENSEE string content of the license. |
char szKeyComment[LMX_MAX_FIELD_LENGTH] |
This field contains the string content embedded within the KEY field. |
char szOptions[LMX_MAX_FIELD_LENGTH] |
This field contains the string content embedded within the OPTIONS field. |
char szSN[LMX_MAX_FIELD_LENGTH] |
This field contains the string content embedded within the SN field. |
char szKey[LMX_MAX_FIELD_LENGTH] |
This field contains the KEY signature of the license. |
int nAvailableLicCount |
This integer contains the number of licenses available on the license server: |
int nUsedLicCount |
This integer contains the number of licenses taken from the license server for the particular feature. The number is within the range LMX_MIN_COUNT to LMX_MAX_COUNT. |
int nMajorVer |
This integer contains major and minor version numbers. |
int nSoftLimit |
This integer contains the soft limit for the specific feature. |
int nShareCode |
This integer contains the type of sharing in use for the specific feature. |
LMX_LICENSE_TYPE eLicenseType |
This enum contains the license type, which can be one of the following:
|
LMX_KEYTYPE eKeyType |
This integer contains the keytype, which can be one of the following:
|
LMX_TOKEN_DEPENDENCY *pTokenDependency |
This pointer holds information about any token dependencies the feature has. (Applies only to network licenses.) |
char szPath[LMX_MAX_SHORT_STRING_LENGTH] |
This field contains the path for the license, which will be one of the following:
|
int nServerPort |
This integer contains the port number used by the license server. It is set only when eLicenseType is LMX_TYPE_NETWORK. |
int nClientLicenseHostids |
These fields contain information about how many and which hostids the feature is bound to.
|
int nHoldMinutes |
These integers contain information about the number of hold minutes, borrow hours, and grace hours set for the feature in the license. |
int nActualBorrowHours |
This integer contains information about the actual number of borrow hours, which may be restricted by an administrator on the license server. |
char szUniqueID[LMX_MAX_SHORT_STRING_LENGTH] |
This string can be used to identify a unique issued license. You can use this information to track specific licenses or for blacklisting. |
int nSystemClockCheck |
This integer contains information about whether a system clock check has been performed. |
int nHostidLicenseMatchRate |
This integer contains the hostid matching rate as specified by the license. |
int nHostidActualMatchRate |
This integer contains the actual hostid matching performed at checkout. Using this information, you can see the results of the actual hostid verification. |
int nUserBasedCount |
This integer contains the user-based reservation count required for the license. |
int nHostBasedCount |
This integer contains the host-based reservation count required for the license. |
int sTimeZones[LMX_MAX_SHORT_STRING_LENGTH] |
This array of integers contains the allowed time zones relative to GMT. |
int nTrialUses |
This integer contains the number of possible uses for trial licenses. |
int nBlacklisted |
This integer contains information about whether a license has been blacklisted. |