.. index:: 
  !FaceCandidateList.clone Method
  
.. _id3_face_face_candidate_list_clone_class_method:

===============================================================================
FaceCandidateList.clone Method
===============================================================================

Module: :ref:`FaceCandidateList<id3_face_face_candidate_list_class>`

Definition
----------

Clones the FaceCandidateList object.


.. tab-set::

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

      .. code:: Python

        clone(self) -> FaceCandidateList

      **Returns**

        .. line-block::

          :ref:`FaceCandidateList<id3_face_face_candidate_list_class>`
          The newly created face candidate list.

      **Exceptions**

        .. line-block::

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


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

      .. code:: Dart

        FaceCandidateList clone()

      **Returns**

        .. line-block::

          :ref:`FaceCandidateList<id3_face_face_candidate_list_class>`
          The newly created face candidate list.

      **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 FaceCandidateList Clone()

      **Returns**

        .. line-block::

          :ref:`FaceCandidateList<id3_face_face_candidate_list_class>`
          The newly created face candidate list.

      **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 FaceCandidateList clone() throws FaceException

      **Returns**

        .. line-block::

          :ref:`FaceCandidateList<id3_face_face_candidate_list_class>`
          The newly created face candidate list.

      **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 clone() throws -> FaceCandidateList

      **Returns**

        .. line-block::

          :ref:`FaceCandidateList<id3_face_face_candidate_list_class>`
          The newly created face candidate list.

      **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 id3FaceCandidateList_CopyTo (
            ID3_FACE_CANDIDATE_LIST hFaceCandidateList, 
            ID3_FACE_CANDIDATE_LIST hFaceCandidateListDst)

      **Parameters**

        .. line-block::

          ``hFaceCandidateList`` :ref:`ID3_FACE_CANDIDATE_LIST<id3_face_face_candidate_list_class>`
          :guilabel:`in` Handle to the FaceCandidateList object.

          ``hFaceCandidateListDst`` :ref:`ID3_FACE_CANDIDATE_LIST<id3_face_face_candidate_list_class>`
          :guilabel:`out` The newly created face candidate list.


      **Returns**

        .. line-block::

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


