VLSucgSetUpgradeCapacity
Syntax
int VLSucgSetUpgradeCapacity ( VLSucg_HANDLE iHandle, ucodeT *ucodeP, char *decimalNum);
| Argument | Description |
| iHandle |
Instance handle for this library. |
| ucodeP |
The pointer to ucodeT struct. |
| decimalNum |
Controls the capacity. >If cap_increment is 0, capacity shall be a multiple of 1(s), maximum 1022. >If cap_increment is 1, capacity shall be a multiple of 10(s), maximum 10220. >If cap_increment is 2, capacity shall be a multiple of 100(s), maximum 102200. >If cap_increment is 3, capacity shall be a multiple of 1000(s), maximum 1022000. >If cap_increment is 4, capacity shall be a multiple of 10000(s), maximum 10220000. >VLScg_NOLIMIT_STRING or EMPTY(“/0”) String can be used to specify infinite capacity. |
Definition
Sets the value of capacity_increment in the ucodeT struct. This function also checks the input variables for their validity and boundary conditions. Infinite capacity shall also be allowed.
Returns
The status code VLScg_SUCCESS is returned if successful. Otherwise, it will return the following error codes:
| Error Code | Description |
|
VLSucg_INVALID_INPUT |
If either the ucodeP or decimalNum is passed as NULL. |
|
VLSucg_NOT_MULTIPLE |
If value of decimalNum is not a correct multiple. |
|
VLSucg_INVALID_INT_TYPE |
If value of decimalNum is not numeric. |
|
VLSucg_EXCEEDS_MAX_ VALUE |
If the value of decimalNum exceeds maximum allowed. |
|
VLSucg_LESS_THAN_MIN_ VALUE |
If the value of decimalNum is lower than the minimum allowed. |
For the complete list of the error codes, refer to Upgrade License Error Codes.