EA_AddinLicenseValidate

Description

When a user directly enters a license key that doesn't match a Sparx Systems key into the License Management dialog, EA_AddInLicenseValidate is broadcast to all Enterprise Architect Add-Ins, providing them with a chance to use the Add-In key to determine the level of functionality to provide. When a key is retrieved from the Sparx Systems Keystore only the target Add-In will be called with the key.

For the Add-In to validate itself against this key, the Add-In's EA_AddinLicenseValidate handler should return confirmation that the license has been validated. As the EA_AddinLicenseValidate event is broadcast to all Add-Ins, one license can validate many Add-Ins.

If an Add-In elects to handle a license key by returning a confirmation to EA_AddinLicenseValidate, it is called upon to provide a description of the license key through the EA_AddinLicenseGetDescription event. If more than one Add-In elects to handle a license key, the first Add-In that returns a confirmation to EA_AddinLicenseValidate is queried for the license key description.

Syntax

Function EA_AddInLicenseValidate (Repository As EA.Repository, AddinKey As String) As Boolean

Parameter

Type

Direction

Description

AddinKey

String

IN

The Add-in license key that has been entered in the License Management dialog.

 

Repository

EA.Repository

IN

An EA.Repository object representing the currently open Enterprise Architect model. Poll its members to retrieve model data and user interface status information.

 

Return Value

Returns a string of the format:

EASK-YOURCODE-REALKEY

 

 

·EASK - Constant string that identifies a shared key for an Enterprise Architect Add-In
·YOURCODE - The code you select and verify with us:
·Displayed to the administrator of the keystore
·Recommended length of 6-10 characters
·Contains ASCII characters 33-126, except for '-' (45)
 
·REALKEY - Encoding of the actual key or checksums
·Recommended length of 8-32 characters
·Contains ASCII characters 33-126

 

We recommend that you contact Sparx Systems directly with proposed values to ensure that you don't clash with any other Add-Ins.

For example, the following keys would all be interpreted as belonging to an Add-In returning MYADDIN from this function:

·EASK-MYADDIN-Test
·EASK-MYADDIN-{7AC4D426-9083-4fa2-93B7-25E2B7FB8DC5}
·EASK-MYADDIN-7AC4D426-9083-4fa2-93B7
·EASK-MYADDIN-25E2B7FB8DC5
·EASK-MYADDIN-2hDfHKA5jf0GAjn92UvqAnxwC13dxQGJtH7zLHJ9Ym8=
 

Learn more