Variables And Error Codes
QVGuard QlikView Variables
The following are the most important QlikView variables created by QVGuard which you should be aware of. You can use these in your QlikView scripts and macros to adjust or reduce the functionality of your QlikView applications depending on the licence file present.
| Variable Name | Description |
| licIsLicensed | If this value is 'True', QVGuard has found a valid licence file. Otherwise the value is 'False'. |
| licIsTrialVersion | 'True' if the 'Is Trial Version' checkbox was checked when the licence was generated. Otherwise 'False' |
| licFailureCode | If the licence check failed, a numeric value will be given here indicating the reason. See the table below for a list of these codes. You may wish to use this to display a localised message to your end user. |
| licFailureStringShort | If the licence check failed, a short description will be given here indicating the reason. See the table below for a list of these codes. |
| licFailureStringLong | If the licence check failed, a longer description will be given here in English indicating the reason. |
| licUserName | This is the name entered in QVGuard studio for the user. |
| licUserSetting1 | This is the value entered for 'User Setting 1' in QVGuard Studio. |
| licUserSetting2 | This is the value entered for 'User Setting 2' in QVGuard Studio. |
| licUserSetting3 | This is the value entered for 'User Setting 3' in QVGuard Studio. |
QVGuard Error Codes
The following are the possible error codes which can be returned for the licFailureCode and licFailureStringShort variables mentioned above. You may wish to use these to provide useful feedback to your end users.
| licFailureCode | licFailureStringShort | Description |
| 0 | None | The licence check succeeded. |
| 1 | Licence_File_Location_Could_Not_Be_Determined | QVGuard could not find where the licence files are stored on the machine. This usually means the user has not run the QVGuard Client at least once. |
| 2 | Licence_Not_Found | No licence file could be found for this QlikView application. |
| 3 | Licence_Not_Valid | The licence file was invalid. This could mean it has become corrupted or was not created by the original vendor of the QlikView application. |
| 4 | QlikView_Licence_Key_Not_Matched | This means that a 16 digit QlikView Licence Key was specified when generating the licence file but the end user's QlikView installation is not using this QlikView licence key. |
| 5 | Licence_File_Expired | The QVGuard licence file had an expiry date set and this date has passed. |
| 6 | Newer_Version_Of_QVGuard_Client_Required | The QVGuard licence uses a feature not supported in this version of the QVGuard Client. The end user should download the very latest free QVGuard Client. |
| 7 | Unexpected_Exception | An unexpected exception has ocurred. |
| 8 | Could_Not_Create_QVGuard_Client | The QVGuard Client could not be accessed/created. This usually means that either the end user has not installed the free QVGuard Client or they have not given their QlikView macros system access as required. |
Click here to go to the QVGuard Studio main documentation.
