Class LicenseValidator

Manages licenses that unlock licensed features

Inheritance
object
LicenseValidator
Namespace: ABB.Robotics.RobotStudio
Assembly: ABB.Robotics.RobotStudio.dll
Syntax
public static class LicenseValidator

Properties

View Source

CurrentVersion

Gets the version string required for licenses used by the current product version.

Declaration
public static string CurrentVersion { get; }
Property Value
Type Description
string
View Source

Disabled

Indicates that all licensed functionality should be disabled, and the application should run in basic mode.

Declaration
public static bool Disabled { get; set; }
Property Value
Type Description
bool
View Source

Initialized

Declaration
public static bool Initialized { get; }
Property Value
Type Description
bool

Methods

View Source

AcquireFeatures(IEnumerable<string>)

Declaration
[Obsolete("No longer supported")]
public static void AcquireFeatures(IEnumerable<string> features)
Parameters
Type Name Description
IEnumerable<string> features
View Source

AcquireLicense(string)

Declaration
[Obsolete("Use declarative licensing")]
public static void AcquireLicense(string feature)
Parameters
Type Name Description
string feature
View Source

AcquireLicense(string, LicenseHoldType)

Declaration
[Obsolete("Use declarative licensing")]
public static bool AcquireLicense(string feature, LicenseHoldType hold)
Parameters
Type Name Description
string feature
LicenseHoldType hold
Returns
Type Description
bool
View Source

AcquireLicense(string, LicenseHoldType, bool, bool)

Declaration
[Obsolete("Use declarative licensing")]
public static bool AcquireLicense(string feature, LicenseHoldType hold, bool allowLocal, bool allowFloating)
Parameters
Type Name Description
string feature
LicenseHoldType hold
bool allowLocal
bool allowFloating
Returns
Type Description
bool
View Source

AcquireLicense(string, string, bool)

Declaration
[Obsolete("Use declarative licensing")]
public static bool AcquireLicense(string feature, string version, bool keep)
Parameters
Type Name Description
string feature
string version
bool keep
Returns
Type Description
bool
View Source

AcquireLicenseToken(string)

Declaration
[Obsolete("Use declarative licensing")]
public static IDisposable AcquireLicenseToken(string feature)
Parameters
Type Name Description
string feature
Returns
Type Description
IDisposable
View Source

GetInstalledLicenses()

Returns information about all licenses on the client and the server

Declaration
public static ReadOnlyCollection<LicenseInformation> GetInstalledLicenses()
Returns
Type Description
ReadOnlyCollection<LicenseInformation>
View Source

GetLastError()

Declaration
[Obsolete("No longer supported")]
public static string GetLastError()
Returns
Type Description
string
View Source

GetLicenseInformation(string, out LicenseInformation)

Returns information about the license for a specific feature

Declaration
public static bool GetLicenseInformation(string feature, out LicenseInformation licenseInformation)
Parameters
Type Name Description
string feature

Feature name
LicenseInformation licenseInformation
Returns
Type Description
bool

True if the feature was found
View Source

GetLicenseInformation(string, string)

Declaration
[Obsolete("Use GetLicenseInformation(string feature, out LicenseInformation licenseInformation) instead")]
public static LicenseInformation GetLicenseInformation(string feature, string version)
Parameters
Type Name Description
string feature
string version
Returns
Type Description
LicenseInformation
View Source

GetLicenseState(string)

Returns information about the license state for a specific feature

Declaration
public static string GetLicenseState(string feature)
Parameters
Type Name Description
string feature

Feature name
Returns
Type Description
string

"Valid" if a valid license exists, empty string or eror message otherwise.
View Source

Initialize()

This method must be called before any other licensing related or protected methods. It will throw an exception if the license store is not properly configured.

Declaration
public static void Initialize()
Remarks

This method is called by RobotStudioAPI.Initialize(), so there is normally no need to call this explicitly.

View Source

InstallLicense(byte[], out LicenseInformation)

Installs a binary license from a manual activation.

Declaration
public static bool InstallLicense(byte[] licenseKey, out LicenseInformation licenseInformation)
Parameters
Type Name Description
byte[] licenseKey
LicenseInformation licenseInformation
Returns
Type Description
bool
View Source

InstallLicense(byte[], out LicenseInformation, bool)

Declaration
[Obsolete("Use InstallLicense(Byte[] licenseKey, out LicenseInformation licenseInformation) instead")]
public static bool InstallLicense(byte[] licenseKey, out LicenseInformation licenseInformation, bool checkOverwrite)
Parameters
Type Name Description
byte[] licenseKey
LicenseInformation licenseInformation
bool checkOverwrite
Returns
Type Description
bool
View Source

IsNotLicensedException(Exception)

Returns true if an Exception is caused by executing a protected method when no valid license is available.

Declaration
public static bool IsNotLicensedException(this Exception ex)
Parameters
Type Name Description
Exception ex
Returns
Type Description
bool
View Source

IsValidLicenseAvailable(string)

Checks if there is a valid license available for a feature, but does not perform a full validation.

Declaration
public static bool IsValidLicenseAvailable(string feature)
Parameters
Type Name Description
string feature
Returns
Type Description
bool
Remarks

This should only be used as a hint if a licensed functionality should be enabled. Use declarative code protection to enforce licensing when the functionality is executed.

View Source

ReleaseLicense(string)

Declaration
[Obsolete("Use declarative licensing")]
public static void ReleaseLicense(string feature)
Parameters
Type Name Description
string feature
View Source

ReleaseLicense(string, string)

Declaration
[Obsolete("Use declarative licensing")]
public static void ReleaseLicense(string feature, string version)
Parameters
Type Name Description
string feature
string version
View Source

Shutdown()

Declaration
[Obsolete("No longer required")]
public static void Shutdown()
View Source

TryAcquireLicense(string)

Declaration
[Obsolete("Use declarative licensing")]
public static bool TryAcquireLicense(string feature)
Parameters
Type Name Description
string feature
Returns
Type Description
bool
View Source

UninstallLicense(string)

Uninstalls the license with the specified activation key.

Declaration
public static bool UninstallLicense(string activationKey)
Parameters
Type Name Description
string activationKey
Returns
Type Description
bool