EA_GetSharedAddinName

Description

As an add-in writer you can distribute keys to your add-in via the Enterprise Architect Keystore providing your keys are generated using a prefix that allows Enterprise Architect to identify the add-in to which they belong. EA_GetSharedAddinName is called by Enterprise Architect to determine what prefix an add-in is using. If a matching key is found in the keystore the License Management dialog will display the name returned by EA_AddinLicenseGetDescription to your users. Finally, when the user selects a key, that key will be passed to your add-in to validate by calling EA_AddinLicenseValidate.

Syntax

Function EA_GetSharedAddinName (Repository as EA.Repository) As String

Parameter

Type

Direction

Description

Repository

EA.Repository

IN

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

 

Return Value

A String containing a product name code for the provided Add-In. This will be shown in plain text at the start of any keys added to the keystore. We recommend contacting Sparx Systems directly with proposed values to ensure you don't clash with any other add-ins.

eg. The following keys would all be interpreted as belonging to an add-in returning "MYADDIN" from this function:

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

Learn more