Contact
Newsletter
Schedule Consultation

LicenseManager

  • Unless stated otherwise, all objects are available in the following Across versions:
  • 5.7
  • 6.0
  • 6.3
  • 7.0
Tip

Function-specific return values are listed with each function.

For more information on return values and a complete list of error codes, see Function Return Types.

Function
Description
Assigns a license to a user.
Creates a new license.
Deletes a license.
Disables a license. Enables a license.
Enables a license.
Gets the ID of a license by its name.
Gets the name of a license by its ID.
Saves the softkey of a specific license to a file.
Sets the data of the specified license.
Unassigns a license from the assigned user.

LicenseManager.AssignLicenseToUser

Assigns a license to a user.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license to be assigned to the specified user.
3
string
UserGuid
The GUID of the user.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
2
User does not exist.
Error
47
Unable to find license key.
Error
65
Unable to assign license to user.

LicenseManager.CreateLicense

Creates a new license.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
LicenseName
The name of the license.
3
bool
IsOnlineLicense
Specifies whether this license is an online or an offline license.

Return Values

Result
Type/Value
Interpretation
Success
int
The license ID.
Error
63
Unable to create license.
Error
69
The license already exists.

LicenseManager.DeleteLicense

Deletes a license.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license to be deleted.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
47
Unable to find license key.
Error
64
Unable to delete license.

LicenseManager.DisableLicense

Disables a license.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license to be disabled.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
47
Unable to find license key.
Error
118
Unable to delete license. Cannot switch license status.
Attention

The function will fail in case the user is currently logged in.

Tip

This is the opposite of the function EnableLicense.

LicenseManager.EnableLicense

Enables a license.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license to be enabled.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
47
Unable to find license key.
Error
118
Unable to delete license. Cannot switch license status.
Attention

The function will fail in case the user is currently logged in.

Tip

This is the opposite of the function DisableLicense.

LicenseManager.LicenseIdByName

Gets the ID of a license by its name.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
LicenseName
The name of the license.

Return Values

Result
Type/Value
Interpretation
Success
int
The license ID.
Error
47
Unable to find license key.

LicenseManager.LicenseNameById

Gets the name of a license by its ID.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license for which the name is to be returned.

Return Values

Result
Type/Value
Interpretation
Success
string
The license name.
Error
47
Unable to find license key.

LicenseManager.SaveSoftkeyOfLicense

Saves the softkey of a specific license to a file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license for which the softkey is to be saved.
 
string
Path
The path to the target file where the softkey should be saved. The user account under which the crossAPI service runs needs to have write access to the containing directory.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
47
Unable to find license key.
Error
68
Unable to save softkey.

LicenseManager.SetLicenseData

Sets the data of the specified license.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license for which the data is to be set.
3
string
Description
The description that should be associated with the license.
4
string
Salutation
The salutation that should be associated with the license.
5
string
FirstName
The first name that should be associated with the license.
6
string
LastName
The last name that should be associated with the license.
7
string
Email
The e-mail address that should be associated with the license.
8
string
Street
The street that should be associated with the license.
9
string
City
The city that should be associated with the license.
10
string
Zip
The ZIP code that should be associated with the license.
11
string
Phone
The phone number that should be associated with the license.
12
string
Mobile
The mobile phone number that should be associated with the license.
13
string
Fax
The fax number that should be associated with the license.
14
string
Web
The web address that should be associated with the license.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
47
Unable to find license key.
Error
67
Unable to set license data.

LicenseManager.UnassignLicenseFromUser

Unassigns a license from the assigned user.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
int
LicenseID
The ID of the license to be unassigned from its user.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
47
Unable to find license key.
Error
66
Unable to unassign license from user.