.. index:: 
  !DocumentLicense.getLicenseFileSerial Method
  
.. _id3_document_document_license_get_license_file_serial_class_method:

===============================================================================
DocumentLicense.getLicenseFileSerial Method
===============================================================================

Module: :ref:`DocumentLicense<id3_document_document_license_class>`

Definition
----------

Retrieves the serial number of the previously loaded license.


.. tab-set::

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

      .. code:: Python

        @staticmethod
        get_license_file_serial() -> str

      **Returns**

        .. line-block::

          ``str``
          The license serial number.

      **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 getLicenseFileSerial()

      **Returns**

        .. line-block::

          ``String``
          The license serial number.

      **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 GetLicenseFileSerial()

      **Returns**

        .. line-block::

          ``string``
          The license serial number.

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

      **Returns**

        .. line-block::

          ``String``
          The license serial number.

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

      **Returns**

        .. line-block::

          ``String``
          The license serial number.

      **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_GetLicenseFileSerial (
            char * licenseFileSerial, 
            int * licenseFileSerialSize)

      **Parameters**

        .. line-block::

          ``licenseFileSerial`` char *
          :guilabel:`out` The license serial number.

          ``licenseFileSerialSize`` int *
          :guilabel:`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**

        .. line-block::

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


