llkGetExecutionsBalance
Description
Retrieve the current balance (remaining quantity).
This topic is only relevant when the license type for a Feature is LLK_EXECUTIONS
Syntax
llkGetExecutionsBalance
LLKStatus LLK_API llkGetExecutionsBalance(uint32_t featureId, uint64_t* curExecutionsBalance);
Parameters
| Param | Description |
|---|---|
| featureId | Feature number |
| curExecutionsBalance | Pointer of the variable |
Return Values
| Status Code | No. | Description |
|---|---|---|
| LLK_OK | 0 | Request was successfully completed. The operation status is successful |
| LLK_INVALID_PARAMETER | 1 | The parameter curExecutionsBalance is invalid (null pointers are forbidden) |
| LLK_FEATURE_NOT_FOUND | 2 | Requested Feature not found |
| LLK_FEATURE_EXPIRED | 4 | Requested Feature has expired |
| LLK_FEATURE_UNSUPPORTED_OPERATION | 5 | Feature type does not support the requested operation (relevant when the license type for a Feature is LLK_EXECUTIONS type) |
| LLK_FEATURE_INSUFFICIENT_EXECUTIONS_COUNT | 6 | Requested quantity is greater than current balance. The license for the Feature does not contain enough remaining executions |
| LLK_FINGERPRINT_MISMATCH | 10 | The fingerprint of the current machine mismatch the activation fingerprint |
| LLK_SERIAL_NUMBER_MISMATCH | 11 | If a Program key with some Serial number installed, the attempt to initialize the environment with another serial number can't be successful. This is a protection for unintentional overwrites |
| LLK_LICENSE_NOT_ACTIVATED_YET | 12 | The entitlement has not been activated yet. For activation/initialization, use llkActivateLicense |
Examples
C++ example
uint64_t curExecutionsBalance = 0;
const LLKStatus status = llkGetExecutionsBalance(featureId, &curExecutionsBalance);
std::cout << "LLKStatus: " <<
llkStatusDescription(status) <<
" Balance: " << curExecutionsBalance << std::endl
Example of a successful operation
LLKStatus: The operation status is successful. Balance: 500
Note
In order to successfully use all other API functions, the entitlement must be activated or initialized. For activation/initialization, use llkActivateLicense
Version history
- Added in version
1.0.0