Navigation: Function Reference and Error Codes > Commands in Alphabetical Order:

checkModuleSubscription

Contents

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> or the API command setSubGraceDays.

Additional API commands

•	Use setSubGraceDays to overwrite the default value of the template <SubGraceDays>

•	Use getRemainingSubgraceDays to retrieve the remaining grace time as an exact double value (e.g. 2.8765 days)

Name

checkModuleSubscription

Purpose

Contacts the Licence Protector MAC Edition 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	NSString	leave empty	not in use
Module ID	NSString	QHD001	ModuleID – identifies the module
ID	NSString	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	leave empty	not in use
Name	NSString	default	not in use
Encryption Code	NSString	leave empty	not in use
DownloadFull	Boolean	leave empty	not in use

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 ofreturn codes