.. index:: 
  !DetectedFaceList.get Method
  
.. _id3_face_detected_face_list_get_class_method:

===============================================================================
DetectedFaceList.get Method
===============================================================================

Module: :ref:`DetectedFaceList<id3_face_detected_face_list_class>`

Definition
----------

Gets an item of the DetectedFaceList object.


.. tab-set::

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

      .. code:: Python

        get(self, index: int) -> DetectedFace

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the DetectedFace item to get.


      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          DetectedFace item to get.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


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

      .. code:: Dart

        DetectedFace get(int index)

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the DetectedFace item to get.


      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          DetectedFace item to get.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public DetectedFace Get(int index)

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the DetectedFace item to get.


      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          DetectedFace item to get.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public DetectedFace get(int index) throws FaceException

      **Parameters**

        .. line-block::

          ``index`` int
          :guilabel:`in` Index of the DetectedFace item to get.


      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          DetectedFace item to get.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public func get(index: Int32) throws -> DetectedFace

      **Parameters**

        .. line-block::

          ``index`` Int32
          :guilabel:`in` Index of the DetectedFace item to get.


      **Returns**

        .. line-block::

          :ref:`DetectedFace<id3_face_detected_face_class>`
          DetectedFace item to get.

      **Exceptions**

        .. line-block::

          :ref:`FaceException<id3_face_face_exception>`
          An error has occurred during Face Library execution.


    .. tab-item:: C
      :sync: C

      .. code:: C

        int id3DetectedFaceList_Get (
            ID3_DETECTED_FACE_LIST hDetectedFaceList, 
            int index, 
            ID3_DETECTED_FACE hDetectedFaceItem)

      **Parameters**

        .. line-block::

          ``hDetectedFaceList`` :ref:`ID3_DETECTED_FACE_LIST<id3_face_detected_face_list_class>`
          :guilabel:`in` Handle to the DetectedFaceList object.

          ``index`` int
          :guilabel:`in` Index of the DetectedFace item to get.

          ``hDetectedFaceItem`` :ref:`ID3_DETECTED_FACE<id3_face_detected_face_class>`
          :guilabel:`out` DetectedFace item to get.


      **Returns**

        .. line-block::

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


