.. index:: 
  !DocumentAuthenticator.authenticateHolograms Method
  
.. _id3_document_document_authenticator_authenticate_holograms_class_method:

===============================================================================
DocumentAuthenticator.authenticateHolograms Method
===============================================================================

Module: :ref:`DocumentAuthenticator<id3_document_document_authenticator_class>`

Definition
----------

Authenticates the holograms on the current frame buffer.

.. important:: Buffer must be full to the temporal window size.


.. tab-set::

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

      .. code:: Python

        authenticate_holograms(self) -> HologramAuthenticationResultList

      **Returns**

        .. line-block::

          :ref:`HologramAuthenticationResultList<id3_document_hologram_authentication_result_list_class>`
          List of result for each hologram enrolled in document.

      **Exceptions**

        .. line-block::

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


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

      .. code:: Dart

        HologramAuthenticationResultList authenticateHolograms()

      **Returns**

        .. line-block::

          :ref:`HologramAuthenticationResultList<id3_document_hologram_authentication_result_list_class>`
          List of result for each hologram enrolled in document.

      **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 HologramAuthenticationResultList AuthenticateHolograms()

      **Returns**

        .. line-block::

          :ref:`HologramAuthenticationResultList<id3_document_hologram_authentication_result_list_class>`
          List of result for each hologram enrolled in document.

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

      **Returns**

        .. line-block::

          :ref:`HologramAuthenticationResultList<id3_document_hologram_authentication_result_list_class>`
          List of result for each hologram enrolled in document.

      **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 authenticateHolograms() throws -> HologramAuthenticationResultList

      **Returns**

        .. line-block::

          :ref:`HologramAuthenticationResultList<id3_document_hologram_authentication_result_list_class>`
          List of result for each hologram enrolled in document.

      **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_AuthenticateHolograms (
            ID3_DOCUMENT_AUTHENTICATOR hDocumentAuthenticator, 
            ID3_DOCUMENT_HOLOGRAM_AUTHENTICATION_RESULT_LIST hScoreList)

      **Parameters**

        .. line-block::

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

          ``hScoreList`` :ref:`ID3_DOCUMENT_HOLOGRAM_AUTHENTICATION_RESULT_LIST<id3_document_hologram_authentication_result_list_class>`
          :guilabel:`out` List of result for each hologram enrolled in document.


      **Returns**

        .. line-block::

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


