.. index:: 
  !DocumentInfo.format Property

.. _id3_document_document_info_format_class_member:

===============================================================================
DocumentInfo.format Property
===============================================================================

Module: :ref:`DocumentInfo<id3_document_document_info_class>`

Type: :ref:`DocumentFormat<id3_document_document_format_enum>`

Definition
----------

The document format.


.. tab-set::

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

    .. code:: Python

      format: DocumentFormat


    **Exceptions**

      .. line-block::

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

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

    .. code:: Dart

      DocumentFormat get format => getFormat();


    **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 DocumentFormat format
      {
          get => Getformat();
      }


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


    **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 var format: DocumentFormat
          get {
              return try! getFormat()
          }
      }


    **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 id3DocumentInfo_GetFormat (ID3_DOCUMENT_INFO hDocumentInfo, id3DocumentFormat * eFormat)

    **Returns**
   
      .. line-block::

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

