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

# DocumentLicense.getModuleName Method

Module: DocumentLicense

## Definition

Retrieves the name of the specified license module.

Python

    @staticmethod
    get_module_name(index: int) -> str

Parameters

> `index` int
> in Index of the module, starting from 0.

Returns

> `str`
> The license module name.

Exceptions

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

Dart

    static String getModuleName(int index)

Parameters

> `index` int
> in Index of the module, starting from 0.

Returns

> `String`
> The license module name.

Exceptions

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

C#

    public static string GetModuleName(int index)

Parameters

> `index` int
> in Index of the module, starting from 0.

Returns

> `string`
> The license module name.

Exceptions

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

Java

    public static String getModuleName(int index) throws DocumentException

Parameters

> `index` int
> in Index of the module, starting from 0.

Returns

> `String`
> The license module name.

Exceptions

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

Swift

    public static func getModuleName(index: Int32) throws -> String

Parameters

> `index` Int32
> in Index of the module, starting from 0.

Returns

> `String`
> The license module name.

Exceptions

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

C

    int id3DocumentLicense_GetModuleName (
        int index,
        char * name,
        int * nameSize)

Parameters

> `index` int
> in Index of the module, starting from 0.
> `name` char *
> out The license module name.
> `nameSize` int *
> in Size of the ‘name’ buffer. Receives the minimum required buffer size to hold the ‘name’ string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in ‘name’ (excluding terminating NULL character).

Returns

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