VLSucgSetUpgradeVersion
Syntax
int VLSucgSetUpgradeFlag ( VLSucg_HANDLE iHandle, ucodeT *ucodeP, char *upgrade_version );
Argument | Description |
iHandle |
Instance handle for this library. |
ucodeP |
The pointer to ucodeT struct. |
upgrade_version |
Any printable ASCII except for #. Maximum of 11 characters. |
Description
Sets the value of upd_version in the ucodeT struct to the value of upgrade_version. This function 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 either the ucodeP or upgrade_version is passed as NULL. Also, if the upgrade_version does not contain a valid string. |
VLSucg_INVALID_CHARS |
If upgrade_version characters are not printable. |
VLSucg_RESERV_STR_ERR |
If the upgrade_version is a reserved string. |
VLSucg_EXCEEDS_MAX_STRLEN |
If the length of upgrade_version string exceeds the maximum allowed length. |
For the complete list of the error codes, refer to Upgrade License Error Codes.