VLSgetConsumeLimit
Syntax
LS_STATUS_CODE VMSWINAPI VLSgetConsumeLimit (
LS_HANDLE lshandle,
CONSUME_LIMIT_TYPE consume_type,
long LSFAR *consume_value,
LS_CHALLENGE LSFAR *challenge ); |
Parameter |
Direction |
Data Type |
Description |
|
lshandle |
IN |
LS_HANDLE |
The license handle. A valid license handle is returned by the RMS License Manager when the license request is successful. |
|
consume_type |
IN |
CONSUME_LIMIT_TYPE |
Specifies the type of the limit whose current value is to be obtained. It can be either of the following: >VLS_LIMIT_TYPE_VOLUME – Sets the number of transaction-based limit. >VLS_LIMIT_TYPE_DURATION - Sets the duration-based limit. |
|
consume_value |
OUT |
long |
A pointer to a user allocated memory, which is filled by the API function with the current limit on its return. |
|
challenge |
UNUSED |
LS_CHALLENGE |
Currently unused. Use NULL. |
Description
Returns the current limit stored in the volume transaction licensing database for a particular license.
Returns
The API returns LS_SUCCESS when the API is successful otherwise it returns the following error codes:
|
Status |
Description |
|
VLS_CALLING_ERROR |
>When the consume_value is NULL. >When the consume_type is neither VLS_LIMIT_TYPE_VOLUME, nor VLS_LIMIT_TYPE_DURATION. |
|
LS_BADHANDLE |
An invalid handle. |
|
VLS_NOT_SUPPORTED |
If the API is called with a handle corresponding to a queued client or a capacity token. |
|
VLS_NO_RECORDS_FOUND |
No records for the limit in the database. |
|
VLS_OPERATION_NOT_SUCCESSFUL |
The requested operation failed for any other reason. |