.. index:: 
  !DocumentLicense.getModuleValue Method
  
.. _id3_document_document_license_get_module_value_class_method:

===============================================================================
DocumentLicense.getModuleValue Method
===============================================================================

Module: :ref:`DocumentLicense<id3_document_document_license_class>`

Definition
----------

Retrieves the value associated to the specified license module.


.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        @staticmethod
        get_module_value(name: str) -> int

      **Parameters**

        .. line-block::

          ``name`` str
          :guilabel:`in` Name of the requested module.


      **Returns**

        .. line-block::

          ``int``
          The value associated to the licence module.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        static int getModuleValue(String? name)

      **Parameters**

        .. line-block::

          ``name`` String
          :guilabel:`in` Name of the requested module.


      **Returns**

        .. line-block::

          ``int``
          The value associated to the licence module.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public static int GetModuleValue(string name)

      **Parameters**

        .. line-block::

          ``name`` string
          :guilabel:`in` Name of the requested module.


      **Returns**

        .. line-block::

          ``int``
          The value associated to the licence module.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public static int getModuleValue(String name) throws DocumentException

      **Parameters**

        .. line-block::

          ``name`` String
          :guilabel:`in` Name of the requested module.


      **Returns**

        .. line-block::

          ``int``
          The value associated to the licence module.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

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

      **Parameters**

        .. line-block::

          ``name`` String
          :guilabel:`in` Name of the requested module.


      **Returns**

        .. line-block::

          ``Int``
          The value associated to the licence module.

      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C
      :sync: C

      .. code:: C

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

      **Parameters**

        .. line-block::

          ``name`` const char *
          :guilabel:`in` Name of the requested module.

          ``value`` int *
          :guilabel:`out` The value associated to the licence module.


      **Returns**

        .. line-block::

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


