DocumentLicense.activateActivationKeyBuffer Method

Module: DocumentLicense

Definition

Activates a license using an activation key and returns the license in a data buffer.

@staticmethod
activate_activation_key_buffer(hardware_code: str, activation_key: str, commentary: str) -> bytearray

Parameters

hardware_code str
in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.

activation_key str
in The id3 activation key.

commentary str
in Commentary associated to this license activation.

Returns

bytearray
The license data buffer.

Exceptions

DocumentException
An error has occurred during Document Library execution.
static Uint8List activateActivationKeyBuffer(String? hardwareCode, String? activationKey, String? commentary)

Parameters

hardwareCode String
in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.

activationKey String
in The id3 activation key.

commentary String
in Commentary associated to this license activation.

Returns

Uint8List
The license data buffer.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public static byte[] ActivateActivationKeyBuffer(string hardwareCode, string activationKey, string commentary)

Parameters

hardwareCode string
in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.

activationKey string
in The id3 activation key.

commentary string
in Commentary associated to this license activation.

Returns

byte[]
The license data buffer.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public static byte[] activateActivationKeyBuffer(String hardwareCode, String activationKey, String commentary) throws DocumentException

Parameters

hardwareCode String
in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.

activationKey String
in The id3 activation key.

commentary String
in Commentary associated to this license activation.

Returns

byte[]
The license data buffer.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public static func activateActivationKeyBuffer(hardwareCode: String, activationKey: String, commentary: String) throws -> [UInt8]

Parameters

hardwareCode String
in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.

activationKey String
in The id3 activation key.

commentary String
in Commentary associated to this license activation.

Returns

[UInt8]
The license data buffer.

Exceptions

DocumentException
An error has occurred during Document Library execution.
int id3DocumentLicense_ActivateActivationKeyBuffer (
    const char * hardwareCode,
    const char * activationKey,
    const char * commentary,
    unsigned char * licenseFileBuffer,
    int * licenseFileBufferSize)

Parameters

hardwareCode const char *
in The hardware code on which the license file will be attached, to be retrieved using the GetHostHardwareCode function.

activationKey const char *
in The id3 activation key.

commentary const char *
in Commentary associated to this license activation.

licenseFileBuffer unsigned char *
out The license data buffer.

licenseFileBufferSize int *
in Size of the ‘licenseFileBuffer’ buffer. Receives the number of elements in the ‘licenseFileBuffer’ array.

Returns

int
An error code.
See id3DocumentError file for the list of possible error codes.