Command to make an online validation of a module and download a license file. It will connect to the Activation Server 6, download the license file (if specified) and check if the module / license was locked.
See also CheckModuleSubscription which includes a grace period.
Name
|
CheckModule 
|
Purpose
|
Contacts the Activation Server 6 to validate a license. This function has to be used to implement “Moving licenses” and ongoing checks (“renting your software”).
|
Params
|
Parameter
|
Type
|
Example
|
Note
|
Projectname
|
String
|
Demo Project
|
projectname, if empty the internal projectname of the license file is used – identifies the project on the Activation Server
|
Module ID
|
String
|
QHD001
|
ModuleID – identifies the module
|
ID
|
String
|
yuGEI-5EPc3-9E7Il-3tI8X-7QU5k-6h14R
|
Identifier which is used to check and register this activation. Should be a unique ID like Serial Number, Invoice Number
|
ForceCheck
|
Boolean
|
False
|
If true, CheckModule will always connect to the Activation Server 6, even if it is not necessary regarding the current values
|
RequestLicData
|
Boolean
|
True
|
If set to true, the license file is downloaded from the Activation Server 6
|
Name
|
String
|
default
|
name to identify the license file. One ID can store multiple files using different names like
default-backup-January2010
default-backup-February2010
|
Encryption Code
|
String
|
this is like a password string
|
ensures, that a file can only be downloaded when a password is provided. The password has to be set with the command UploadLic. Should be maximum 40 characters.
|
DownloadFull
|
Boolean
|
true
|
If true, the complete license file is downloaded. Otherwise only the
changes made on the Activation Server 6 are downloaded and updated in the local license file. To only check a license it should be set to false
|
|
Returncode
|
Returncode
Type Integer
|
Note
|
0
|
CheckModule was successful: The online-Validation succeeded or it was not necessary to check the state online
|
3001
|
The Activation Server 6 was not reachable.
|
3010
|
That ID is already used e.g. by another computer.
|
3018
|
That ID is locked.
|
3002-3999
|
Errors on the Activation Server 6, see Activation Server 6 error codes
|
Other return codes
|
Operation failed, see list of return codes
|
|
Usage
|
Used to validate the license.
|
Sample
|
iRes := lic.CheckModule(‘’, ‘QHD001’, ‘yuGEI-5EPc3-9E7Il-3tI8X-7QU5k-6h14R’,true, true);
if iRes = 0 then
begin
<< license successfully validated >>
...
end
else if iRes = 3001 then
begin
<< Activation Server 6 could not be reached, please check connection >>
...
end
else if iRes = 3010 then
begin
<< that license is already in usage. First transfer the license from the other PC to use it on this PC >>
...
end
else if iRes = 3018 then
begin
<< that license is locked on the Activation Server 6.>>
...
end
else
begin
<< other errors >>>
...
|
See also
|
licenseVerification, NextVerification, Deactivatelicense, SetVerificationID, SetVerificationProduct, WebServiceURL, ShowWAStartPage, ShowWAProgressPage, ShowWAResultPage, UseLocalProxy, UseLocalIEProxy, LocalProxyServer, LocalProxyPort, Projectname
|
