.. index:: 
  !DocumentLicense.getLicensePath Method
  
.. _id3_document_document_license_get_license_path_class_method:

===============================================================================
DocumentLicense.getLicensePath Method
===============================================================================

Module: :ref:`DocumentLicense<id3_document_document_license_class>`

Definition
----------

Retrieves the license path.


.. tab-set::

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

      .. code:: Python

        @staticmethod
        get_license_path() -> str

      **Returns**

        .. line-block::

          ``str``
          The license path.

      **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 String getLicensePath()

      **Returns**

        .. line-block::

          ``String``
          The license path.

      **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 string GetLicensePath()

      **Returns**

        .. line-block::

          ``string``
          The license path.

      **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 String getLicensePath() throws DocumentException

      **Returns**

        .. line-block::

          ``String``
          The license path.

      **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 getLicensePath() throws -> String

      **Returns**

        .. line-block::

          ``String``
          The license path.

      **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_GetLicensePath (
            char * licensePath, 
            int * licensePathSize)

      **Parameters**

        .. line-block::

          ``licensePath`` char *
          :guilabel:`out` The license path.

          ``licensePathSize`` int *
          :guilabel:`in` Size of the 'licensePath' buffer. Receives the minimum required buffer size to hold the 'licensePath' string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in 'licensePath' (excluding terminating NULL character).


      **Returns**

        .. line-block::

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


