.. highlightlang:: us

.. index:: IsFileIPW

.. _isfileipw:

IsFileIPW
=========

.. us.tag  IsFileIPW ENGLISH FILE_MISC Changed413 Changed5100

:ref:`IsFileIPW` checks if a file is a UniPlot file (IPW or IPZ).

.. function::  nVersion = IsFileIPW(ssFileName)
               nVersion = IsFileIPW(ssFileName, bReturnSectorSize)

.. us.return

**Return Value**

*nVersion* is the file version, e.g. 5000. In case the file is not an IPW or IPZ
file the function returns 0. If the functions is called with the second parameter
set to TRUE (1) *nVersion* is a vector with two elements. The first element is
the file version and the second element the sector size (512 or 4096). See
:ref:`DocCreate`.

.. us.params

**Parameters**

.. uparam:: ssFileName

   *ssFileName* is the complete path name of the file.

.. uparam:: bReturnSectorSize

   If *bReturnSectorSize* is TRUE (1) the return value contains the used sector
   size of the IPW file.

.. us.history

**History**

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

   * - Version
     - Description
   * - R2012
     - Can be used for IPZ files.

.. seealso::
   :ref:`overview-binary-and-text-files`,
   :ref:`IsFileExcel`,
   :ref:`IsFilenetCDF`,
   :ref:`GetFileAttributes`,
   :ref:`version`

:sub:`id-260129`