.. highlightlang:: us .. index:: DeCompressFile .. _decompressfile: DeCompressFile ============== .. us.tag DeCompressFile ENGLISH file-zip New300 Changed5140 :ref:`DeCompressFile` decompress a file that was compressed by :ref:`CompressFile`. .. function:: bool = DeCompressFile(ssFilename) bool = DeCompressFile(ssFilename, ssFilenameOut) .. us.return **Return Value** *bool* is TRUE (1) if the copy could be created, otherwise FALSE (0). .. us.params **Parameters** .. uparam:: ssFilename *ssFilename* is the filename **without** the extension. If ``DeCompressFile()`` is invoked with one parameter, *ssFilename* is the file name **without** extension. The file must have the extension ``.z``. If ``DeCompressFile()`` is invoked with two parameters, *ssFilename* must be the complete file name with extension. .. uparam:: ssFilenameOut *ssFilenameOut* is the name of the decompressed file. .. us.comment **Comment** This function uses the zlib-Library (http://www.gzip.org/zlib/). Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler. .. us.example **Example** The following function call decompresses the file :file:`d:\\Test.dat.Z`. The file :file:`d:\\Test.dat` will be created. :: DeCompressFile("d:\Test.dat") The following call uncompresses the file :file:`d:\\Test.tar.gz`. The file :file:`Test.tar` is created. :: DeCompressFile("d:\Test.tar.gz", "d:\Test.tar") .. us.history **History** .. list-table:: :header-rows: 1 * - Version - Description * - 5.14.0 - Invokation with two parameters added. * - 3.0 - New. .. seealso:: :ref:`file-zip`, :ref:`CompressFile`, :ref:`mem_compress` :sub:`id-1211081`