Command to make an online validation of a module, considering a grace period if no Internet connection is available and download a license file. It will connect to the Activation Server 4, download the license file (if specified) and check if the module / license was locked.

 

For a complete description see chapter regular online checks.

 

Grace Period

•If a connection to the Activation Server 4 fails, a grace period starts. You will get as a return value = 0 (OK)
•If  a connection can be established during the grace period, you get the real return value and the grace period is reset
•If  a connection cannot be established after the end of the grace period, you get an error code (e.g. 3001)

 

The grace period will only start when there is no connection to the Activation Server 4 but not on other errors like license is locked.

 

Setting the Grace Period

You can either set the grace period in the project template using <SubGraceDays> , SetSubGraceDays or with the command SetVal, Token SGD

 

Additional API commands

 

•Use SetSubGraceDays to overwrite the default value of the template <SubGraceDays>
•Use GetVal, Token SGD to retrieve the number of grace time in full days (integer value) - set with SetSubGraceDays
•Use GetRemainingSubgraceDays to retrieve the remaining grace time as an exact double value (e.g. 2.8765 days)
•Use GetVal, Token SGP to retrieve the expiry date/time of the grace period (date/time value)

 

 

Name

CheckModuleSubscription                                                                                  

Purpose

Contacts the Licence Protector Web Activation server 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, CheckModuleSubscription will always connect to the Activation Server 4, 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 4

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 4 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

CheckModuleSubscription was successful. The online-Validation succeeded or it was not necessary to check the state online. Will also return 0 if connection failed and grace period is active

3001

The Activation Server 4 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 4, see Activation Server 4 error codes

Other return codes

Operation failed, see list of return codes

Usage

Used to validate the license.

Sample

 

  iRes := lic.CheckModuleSubscription(‘’, ‘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 4 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 4.>>

     ...

  end

  else

  begin

    << other errors >>>

     ...

   

See also

GetRemainingSubgraceDays, SetSubGraceDays, Getval - Token SGD, SGP