DocumentLicense.getModuleValue Method

Module: DocumentLicense

Definition

Retrieves the value associated to the specified license module.

Python

@staticmethod
get_module_value(name: str) -> int

Parameters

name str

in Name of the requested module.

Returns

int

The value associated to the licence module.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Dart

static int getModuleValue(String? name)

Parameters

name String

in Name of the requested module.

Returns

int

The value associated to the licence module.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C#

public static int GetModuleValue(string name)

Parameters

name string

in Name of the requested module.

Returns

int

The value associated to the licence module.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Java

public static int getModuleValue(String name) throws DocumentException

Parameters

name String

in Name of the requested module.

Returns

int

The value associated to the licence module.

Exceptions

DocumentException

An error has occurred during Document Library execution.

Swift

public static func getModuleValue(name: String) throws -> Int32

Parameters

name String

in Name of the requested module.

Returns

Int

The value associated to the licence module.

Exceptions

DocumentException

An error has occurred during Document Library execution.

C

int id3DocumentLicense_GetModuleValue (
    const char * name,
    int * value)

Parameters

name const char *

in Name of the requested module.

value int *

out The value associated to the licence module.

Returns

int

An error code.

See id3DocumentError file for the list of possible error codes.