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

# DocumentLicense.getLicenseFileSerial Method

Module: DocumentLicense

## Definition

Retrieves the serial number of the previously loaded license.

Python

    @staticmethod
    get_license_file_serial() -> str

Returns

> `str`
> The license serial number.

Exceptions

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

Dart

    static String getLicenseFileSerial()

Returns

> `String`
> The license serial number.

Exceptions

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

C#

    public static string GetLicenseFileSerial()

Returns

> `string`
> The license serial number.

Exceptions

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

Java

    public static String getLicenseFileSerial() throws DocumentException

Returns

> `String`
> The license serial number.

Exceptions

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

Swift

    public static func getLicenseFileSerial() throws -> String

Returns

> `String`
> The license serial number.

Exceptions

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

C

    int id3DocumentLicense_GetLicenseFileSerial (
        char * licenseFileSerial,
        int * licenseFileSerialSize)

Parameters

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

Returns

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