.. index:: 
  !DocumentLibrary.getVersion Method
  
.. _id3_document_document_library_get_version_class_method:

===============================================================================
DocumentLibrary.getVersion Method
===============================================================================

Module: :ref:`DocumentLibrary<id3_document_document_library_class>`

Definition
----------

Retrieves the library version as a 'X.Y.Z' formatted string.


.. tab-set::

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

      .. code:: Python

        @staticmethod
        get_version() -> str

      **Returns**

        .. line-block::

          ``str``
          A string that identifies the library version.

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

      **Returns**

        .. line-block::

          ``String``
          A string that identifies the library version.

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

      **Returns**

        .. line-block::

          ``string``
          A string that identifies the library version.

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

      **Returns**

        .. line-block::

          ``String``
          A string that identifies the library version.

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

      **Returns**

        .. line-block::

          ``String``
          A string that identifies the library version.

      **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 id3DocumentLibrary_GetVersion (
            char * libraryVersion, 
            int * libraryVersionSize)

      **Parameters**

        .. line-block::

          ``libraryVersion`` char *
          :guilabel:`out` A string that identifies the library version.

          ``libraryVersionSize`` int *
          :guilabel:`in` Size of the 'libraryVersion' buffer. Receives the minimum required buffer size to hold the 'libraryVersion' string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in 'libraryVersion' (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.


