.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteReportPageByPage

.. _OEDepict_OEWriteReportPageByPage:


.. oe:function:: OEWriteReportPageByPage


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

      .. oe:api::

         bool OEWriteReportPageByPage(const std::string& filename,
                                      const OEReport& report)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteReportPageByPage(filename: str, report: OEReport) -> bool

   A convenient function that writes pages of the report into the
   separate numbered files.

   *filename*
      The filename that serves as a prefix to write the report page by page.
      For example, if filename ``test.svg`` is given, the pages of the report
      will be written page by page into files: ``test-01.svg``, ``test-02.svg``
      ...
      The extension of file determines the type of the image.
 
   *report*
      The :ref:`OEReport <OEDepict_OEReport>` object of which pages are
      being written into the separate files.

   .. seealso::

      * :oe:func:`OEDepict::OEIsRegisteredImageFile` function
      * :oe:func:`OEDepict::OEIsRegisteredMultiPageImageFile` function
      * :oe:func:`OEDepict::OEWriteReport` function
