.. include:: ../substitutions

.. oe:namespace:: OEDepict

.. meta::
   :keywords: OEWriteMultiPageImage

.. _OEDepict_OEWriteMultiPageImage:


.. oe:function:: OEWriteMultiPageImage


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

      .. oe:api::

         bool OEWriteMultiPageImage(const std::string& filename,
                                    const OEMultiPageImageFile& image)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMultiPageImage(filename: str, image: OEMultiPageImageFile) -> bool

   Writes the multi-page image into a file with the given name.

   *filename*
      The name of the file into which the image is written.
      The extension of the filename determine the type of the image.

   *image*
      The :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object which is
      being written into the given file.

   .. seealso::

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


   .. ################################################################

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

      .. oe:api::

         bool OEWriteMultiPageImage(OEPlatform::oeostream& os,
                                    const std::string& extension,
                                    const OEMultiPageImageFile& image)

   .. oe:language:: python

      .. oe:api:: python

         OEWriteMultiPageImage(os: oeostream, extension: str,
                               image: OEMultiPageImageFile) -> bool


   Writes the multi-page image into the given output stream.

   *os*
      The stream into which the multi-page image is written.

   *ext*
      The extension which determine the type of the image.

   *image*
      The :ref:`OEMultiPageImageFile <OEDepict_OEMultiPageImageFile>` object which is
      being written into the stream.

   .. seealso::

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


