.. index:: 
  !FaceLibrary.getModelFileName Method
  
.. _id3_face_face_library_get_model_file_name_class_method:

===============================================================================
FaceLibrary.getModelFileName Method
===============================================================================

Module: :ref:`FaceLibrary<id3_face_face_library_class>`

Definition
----------

Retrieves the model file name which is needed in the LoadModel function.


.. tab-set::

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

      .. code:: Python

        @staticmethod
        get_model_file_name(model: FaceModel) -> str

      **Parameters**

        .. line-block::

          ``model`` :ref:`FaceModel<id3_face_face_model_enum>`
          :guilabel:`in` The Face Model to look for.


      **Returns**

        .. line-block::

          ``str``
          The expected file name

      **Exceptions**

        .. line-block::

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


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

      .. code:: Dart

        static String getModelFileName(FaceModel model)

      **Parameters**

        .. line-block::

          ``model`` :ref:`FaceModel<id3_face_face_model_enum>`
          :guilabel:`in` The Face Model to look for.


      **Returns**

        .. line-block::

          ``String``
          The expected file name

      **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 static string GetModelFileName(FaceModel model)

      **Parameters**

        .. line-block::

          ``model`` :ref:`FaceModel<id3_face_face_model_enum>`
          :guilabel:`in` The Face Model to look for.


      **Returns**

        .. line-block::

          ``string``
          The expected file name

      **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 static String getModelFileName(FaceModel model) throws FaceException

      **Parameters**

        .. line-block::

          ``model`` :ref:`FaceModel<id3_face_face_model_enum>`
          :guilabel:`in` The Face Model to look for.


      **Returns**

        .. line-block::

          ``String``
          The expected file name

      **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 static func getModelFileName(model: FaceModel) throws -> String

      **Parameters**

        .. line-block::

          ``model`` :ref:`FaceModel<id3_face_face_model_enum>`
          :guilabel:`in` The Face Model to look for.


      **Returns**

        .. line-block::

          ``String``
          The expected file name

      **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 id3FaceLibrary_GetModelFileName (
            id3FaceModel eModel, 
            char * fileName, 
            int * fileNameSize)

      **Parameters**

        .. line-block::

          ``eModel`` :ref:`id3FaceModel<id3_face_face_model_enum>`
          :guilabel:`in` The Face Model to look for.

          ``fileName`` char *
          :guilabel:`out` The expected file name

          ``fileNameSize`` int *
          :guilabel:`in` Size of the 'fileName' buffer. Receives the minimum required buffer size to hold the 'fileName' string if the given one is too small (including the terminating NULL character), otherwise receives the number of characters in 'fileName' (excluding terminating NULL character).


      **Returns**

        .. line-block::

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


