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

# DocumentLicense.getLicenseFileHardwareCode Method

Module: DocumentLicense

## Definition

Retrieves the hardware code of the previously loaded license.

Python

    @staticmethod
    get_license_file_hardware_code() -> str

Returns

> `str`
> The license hardware code.

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Dart

    static String getLicenseFileHardwareCode()

Returns

> `String`
> The license hardware code.

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C#

    public static string GetLicenseFileHardwareCode()

Returns

> `string`
> The license hardware code.

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Java

    public static String getLicenseFileHardwareCode() throws DocumentException

Returns

> `String`
> The license hardware code.

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Swift

    public static func getLicenseFileHardwareCode() throws -> String

Returns

> `String`
> The license hardware code.

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C

    int id3DocumentLicense_GetLicenseFileHardwareCode (
        char * licenseFileHardwareCode,
        int * licenseFileHardwareCodeSize)

Parameters

> `licenseFileHardwareCode` char *
> out The license hardware code.
> `licenseFileHardwareCodeSize` int *
> in Size of the ‘licenseFileHardwareCode’ buffer. Receives the minimum required buffer size to hold the ‘licenseFileHardwareCode’ string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in ‘licenseFileHardwareCode’ (excluding terminating NULL character).

Returns

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