.. index:: 
  !DocumentAuthenticator.appendFrame Method
  
.. _id3_document_document_authenticator_append_frame_class_method:

===============================================================================
DocumentAuthenticator.appendFrame Method
===============================================================================

Module: :ref:`DocumentAuthenticator<id3_document_document_authenticator_class>`

Definition
----------

Appends a frame in the FIFO buffer.


.. tab-set::

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

      .. code:: Python

        append_frame(self, image: DocumentImage) -> None

      **Parameters**

        .. line-block::

          ``image`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` Source image of the aligned document to append


      **Exceptions**

        .. line-block::

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


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

      .. code:: Dart

        void appendFrame(DocumentImage image)

      **Parameters**

        .. line-block::

          ``image`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` Source image of the aligned document to append


      **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 void AppendFrame(DocumentImage image)

      **Parameters**

        .. line-block::

          ``image`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` Source image of the aligned document to append


      **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 void appendFrame(DocumentImage image) throws DocumentException

      **Parameters**

        .. line-block::

          ``image`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` Source image of the aligned document to append


      **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 func appendFrame(image: DocumentImage) throws

      **Parameters**

        .. line-block::

          ``image`` :ref:`DocumentImage<id3_document_document_image_class>`
          :guilabel:`in` Source image of the aligned document to append


      **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 id3DocumentAuthenticator_AppendFrame (
            ID3_DOCUMENT_AUTHENTICATOR hDocumentAuthenticator, 
            ID3_DOCUMENT_IMAGE hImage)

      **Parameters**

        .. line-block::

          ``hDocumentAuthenticator`` :ref:`ID3_DOCUMENT_AUTHENTICATOR<id3_document_document_authenticator_class>`
          :guilabel:`in` Handle to the DocumentAuthenticator object.

          ``hImage`` :ref:`ID3_DOCUMENT_IMAGE<id3_document_document_image_class>`
          :guilabel:`in` Source image of the aligned document to append


      **Returns**

        .. line-block::

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


