.. highlightlang:: us

.. index:: p7z_unzip

.. _p7z_unzip:

p7z_unzip
=========

.. us.tag p7z_unzip NOTREADYENGLISH file-zip New5510

:ref:`p7z_unzip` extracts files from a ZIP or 7z archive.

.. function:: bool = p7z_unzip(ssZipFile, ssOutputDir, svOptions)

.. us.return

**Return Value**

*ret* is 0, if the function was successful.
In case of an error the function returns an error object (see
:ref:`error_create`).

.. us.params

**Parameters**

.. uparam:: ssZipFile

   *ssZipfile* is the complete file name of the ZIP or 7z file.

.. uparam:: ssOutputDir

   *ssOutputDir* is the output directory.

.. uparam:: svOptions

   *svOptions* are extra parameters, e. g. "-pMyPassword" to set a password. 
   See :ref:`p7z_zip`.

.. us.comment

**Comment**

The function uses the "7-Zip Command Line Version". The program
(``7za.exe``), the license and the documentation (``7-zip.chm``) can be found in
``<uniplot>\program\7zip`` folder.

See also: http://en.wikipedia.org/wiki/7-Zip und http://www.7-zip.org/.

.. us.example

**Example**

::

   p7z_unzip("d:\\test.zip", "d:\\test-dir", "-pMyPassword");

.. us.history

**History**

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

   * - Version
     - Description
   * - R2013.10
     - New.

.. seealso::
   :ref:`file-zip`,
   :ref:`p7z_zip`,
   :ref:`p7z_unzip_buffer`,
   :ref:`p7z_list`

:sub:`id-1130342`