.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetVSFPType

..  _oegraphsim_oegetvsfptype:

.. oe:function:: OEGetVSFPType

   .. oe:language:: c++ java csharp

      .. oe:api::

         const OEFPTypeBase* OEGetVSFPType(const unsigned int fptype,
                                           const unsigned vsversion = 0u)

   .. oe:language:: python

      .. oe:api:: python

         OEGetVSFPType(fptype: int, vsVersion: int = 0) -> OEFPTypeBase

   This function returns a *const* pointer of a default virtual screening fingerprint type.

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.
      If the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree`, or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other fingerprint types that have no virtual screening equivalent
      will emit an error and return null.

   *vsversion*
      The version for the virtual screening fingerprint. Passing a value of ``0u`` requests the
      latest version of the fingerprint from the current toolkit.  Supported values are
      ``1u`` (pre-2025.2 toolkits), and ``0u`` or  ``2u`` (2025.2 toolkits onwards).

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEGetFPType`
         * :ref:`OEMakeVSFP <OEGraphSim_OEMakeVSFP>`

