.. highlightlang:: us

.. index:: CompressFile

.. _compressfile:

CompressFile
============

.. us.tag  CompressFile ENGLISH file-zip New300

:ref:`CompressFile` compresses a file.

.. function::  bool = CompressFile(ssFilename)

.. 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 file mane. :ref:`CompressFile` creates a new file with the
   extension :file:`.Z` (see example).

.. 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 examples creates the file :file:`d:\\Test.tar.gz`.

::

   b = CompressFile("d:\Test.tar")
   if (b) {
      MoveFile("d:\Test.tar.Z", "d:\Test.tar.gz")
   }

.. seealso::
   :ref:`file-zip`,
   :ref:`DeCompressFile`,
   :ref:`mem_compress`

:sub:`id-1829088`