.. highlightlang:: us

.. index:: PageSaveAsMetafile

.. _pagesaveasmetafile:

PageSaveAsMetafile
==================

.. us.tag  PageSaveAsMetafile ENGLISH PageSet Changed310 Changed5309 Changed5900 Changed6000

:ref:`PageSaveAsMetafile` creates a Windows Meta File (.WMF), a Enhanced
Metafile (.EMF), Metafile with Extensions (EMF+) or a combination of EMF and 
EMF+ (EMF+Dual) from the given page.

.. function::  bool = PageSaveAsMetafile(hPage, ssFileName)
    bool = PageSaveAsMetafile(hPage, ssFileName, rsScale)
    bool = PageSaveAsMetafile(hPage, ssFileName, rsScale, nEMF)
    bool = PageSaveAsMetafile(hPage, ssFileName, rsScale, nEMF, bSetViewPort)
    bool = PageSaveAsMetafile(hPage, ssFileName, rsScale, nEMF, bSetViewPort, nClipFlag)

.. us.return

**Return Value**

*bool* TRUE (1) if the file is created successfully; otherwise FALSE (0).

.. us.params

**Parameters**

.. uparam:: hPage

   Identifies the page.

.. uparam:: ssFileName

   *ssFileName* is the name of the Windows Meta File.

.. uparam:: rsScale

   *rsScale* is a scale factor to change the
   size of the Windows Meta File. The range of the factor is 0.1
   to 3.0 (``1% - 300%``). If the parameter is not specified, the
   value 1 is used.

.. uparam:: nEMF

    Sets the meta file format:

   .. list-table::
      :header-rows: 1

      * - Value
        - Description
      * - 0
        - WMF (Default)  (file extension :file:`.wmf`)
      * - 1
        - EMF (file extension :file:`.emf`).
      * - 2
        - EMF+ (file extension :file:`.emf`).
      * - 3
        - EMF + Dual (file extension :file:`.emf`)

.. uparam:: bSetViewPort

   If *bSetViewPort* is TRUE (1) the view port is set. This parameter is no
   impact on EMF files. Default value is TRUE (1). Some programs can only display
   WMF files where the viewport is set and vice versa.

.. uparam:: nClipFlag

   Specifies how the page size is calculated:

   .. list-table::
      :header-rows: 1

      * - Value
        - Description
      * - 0
        - Boundig Box: Rectange enclosing all page elements. (Default value)
      * - 1
        - Boundig Box: clipped at the page edge.
      * - 2
        - Page Size.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - R2018
     - The parameter *nEMF* can have the values 0 to 3.
   * - R2017
     -
   * - 5.3.0
     - New parameter *nClipFlag*.

.. seealso::
   :ref:`overview-document-pages`,
   :ref:`PageSaveAsBitmap`,
   :ref:`AppGetActivePage`,
   :ref:`GetOpenFileName`

:sub:`id-533873`