.. # split from OESystemFunctions.rst:2812

.. include:: ../substitutions

.. oe:namespace:: OESystem

.. _OESystem_OEWriteSettings:

.. meta::
   :keywords: OEWriteSettings

.. oe:function:: OEWriteSettings

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

      .. oe:api::

         bool OEWriteSettings(const OEInterface& itf,
                              OEPlatform::oeostream& ostr = OEOUT,
                              bool include_default = true,
                              std::string mode = "")

   .. oe:language:: python

      .. oe:api:: python

         OEWriteSettings(itf: OEInterface, ostr: oeostream = oeout,
                         include_default: bool = True, mode: str = "") -> bool

   The function writes the current setting of 'itf' to 'ostr'.
   If 'include_default' is ``true`` all parameter will be listed, otherwise
   only parameters specified by the user will be listed.

   The format of this output is such that if 'ostr' is a file stream,
   the created file can be used as a parameter file (*i.e.* passed to a
   param_file parameter) in a subsequent run.
   The function returns ``true`` if it succeeds and ``false`` otherwise.

   'mode' specifies a name of an optimized parameter set for OpenEye's
   applications.

OEBitVector Operators
------------------------------------

