.. highlightlang:: us

.. index:: p7z_unzip_buffer

.. _p7z_unzip_buffer:

p7z_unzip_buffer
================

.. us.tag p7z_unzip_buffer NOTREADYENGLISH file-zip New5510

:ref:`p7z_unzip_buffer` extracts a file from a ZIP or 7z archive and 
returns the data as a string.

.. function:: s = p7z_unzip_buffer(ssZipfile, ssFilename)
              s = p7z_unzip_buffer(ssZipfile, ssFilename, svOptions)

.. us.return

**Return Value**

*s* is a string with the contents of *ssFilename*. The string may contain
0-characters. 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:: ssFilename

   *ssFilename* is a file name of an element in the archive.

.. 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_zip("d:\\script.zip", GetRootDirectory(), "script")
   s = p7z_unzip_buffer("d:\\script.zip", "defines.ic")

.. us.history

**History**

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

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

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

:sub:`id-2008931`