Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# FaceLicense.activate Method

Module: FaceLicense

## Definition

Activates a license using customer credentials and a product reference and saves the license to a file.

Python

    @staticmethod
    activate(hardware_code: str, login: str, password: str, product_reference: str, commentary: str, path: str) -> None

Parameters

> `hardware_code` str
> in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.
> `login` str
> in The id3 account login.
> `password` str
> in The id3 account password.
> `product_reference` str
> in The requested product reference.
> `commentary` str
> in Commentary associated to this license activation.
> `path` str
> in Path to the retrieved license file.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Dart

    static void activate(String? hardwareCode, String? login, String? password, String? productReference, String? commentary, String? path)

Parameters

> `hardwareCode` String
> in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.
> `login` String
> in The id3 account login.
> `password` String
> in The id3 account password.
> `productReference` String
> in The requested product reference.
> `commentary` String
> in Commentary associated to this license activation.
> `path` String
> in Path to the retrieved license file.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C#

    public static void Activate(string hardwareCode, string login, string password, string productReference, string commentary, string path)

Parameters

> `hardwareCode` string
> in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.
> `login` string
> in The id3 account login.
> `password` string
> in The id3 account password.
> `productReference` string
> in The requested product reference.
> `commentary` string
> in Commentary associated to this license activation.
> `path` string
> in Path to the retrieved license file.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Java

    public static void activate(String hardwareCode, String login, String password, String productReference, String commentary, String path) throws FaceException

Parameters

> `hardwareCode` String
> in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.
> `login` String
> in The id3 account login.
> `password` String
> in The id3 account password.
> `productReference` String
> in The requested product reference.
> `commentary` String
> in Commentary associated to this license activation.
> `path` String
> in Path to the retrieved license file.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Swift

    public static func activate(hardwareCode: String, login: String, password: String, productReference: String, commentary: String, path: String) throws

Parameters

> `hardwareCode` String
> in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.
> `login` String
> in The id3 account login.
> `password` String
> in The id3 account password.
> `productReference` String
> in The requested product reference.
> `commentary` String
> in Commentary associated to this license activation.
> `path` String
> in Path to the retrieved license file.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C

    int id3FaceLicense_Activate (
        const char * hardwareCode,
        const char * login,
        const char * password,
        const char * productReference,
        const char * commentary,
        const char * path)

Parameters

> `hardwareCode` const char *
> in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.
> `login` const char *
> in The id3 account login.
> `password` const char *
> in The id3 account password.
> `productReference` const char *
> in The requested product reference.
> `commentary` const char *
> in Commentary associated to this license activation.
> `path` const char *
> in Path to the retrieved license file.

Returns

> `int`
> An error code.
> See id3FaceError file for the list of possible error codes.