VLSucgSetUpgradeCapacityUnits 

Syntax

int VLSucgSetUpgradeCapacityUnits ( VLSucg_HANDLE  iHandle, ucodeT *ucodeP, char *cap_units );

Argument	Description
iHandle	Instance handle for this library.
ucodeP	The pointer to ucodeT struct.
cap_units	Capacity specification units: from 0 to 4. The values are: >If cap_units is 0, capacity shall be a multiple of 1(s), maximum 1022. >If cap_units is 1, capacity shall be a multiple of 10(s), maximum 10220. >If cap_units is 2, capacity shall be a multiple of 100(s), maximum 102200. >If cap_units is 3, capacity shall be a multiple of 1000(s), maximum 1022000. >If cap_units is 4, capacity shall be a multiple of 10000(s), maximum 10220000.

Description

Sets the value of capacity_units in the ucodeT struct. This function should be called either in case of capacity upgrade or in case of both versions and capacity upgrades.

VLSucgSetUpgradeCapacityUnits also checks the input variables for their validity and boundary conditions.

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 the either the ucodeP or cap_units is passed as NULL.
VLSucg_INVALID_INT_TYPE	If value of cap_units is not numeric.
VLSucg_EXCEEDS_MAX_ VALUE	If the value of cap_units exceeds VLScg_CAPACITY_UNITS_MAX_VALUE
VLSucg_LESS_THAN_MIN_ VALUE	If the value of cap_units is lower than VLScg_CAPACITY_UNITS_MIN_VALUE.

For the complete list of the error codes, refer to Upgrade License Error Codes.