.. # split from OESystemFunctions.rst:459

.. include:: ../substitutions

.. oe:namespace:: OESystem

.. meta::
   :keywords: OECheckHelp

.. oe:function:: OECheckHelp

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

      .. oe:api::

         bool OECheckHelp(const OEInterface& itf, int argc, char** argv,
                          bool help_for_no_args = true,
                          OEPlatform::oeostream& ostr = OEERR)

   .. oe:language:: python

      .. oe:api:: python

         OECheckHelp(itf: OEInterface, input: List[str],
                     help_for_no_args: bool = True, ostr: oeostream = oeerr) -> bool

   Return ``true`` if ``--help`` is specified on the commandline given by
   the ``argc`` and ``argv`` arguments. If ``--help`` was found, print
   out a help message to the stream specified by the ``ostr``
   argument, by default, standard error. The ``--help`` flag can also
   be passed as an argument to cause detailed information to be printed
   about that parameter.

   .. seealso::

      Most users should not need to call this function directly. The
      :ref:`OEInterface <OESystem_OEInterface>` constructor and
      :oe:func:`OESystem::OEParseCommandLine` call this function
      internally.

