B4X

GZip Create / Extract .gz File

See more Gzip Examples

Demonstrates how to compress a file to create a .gz (GZip) file.

Note: The .gz file format is a compressed file format. It contains a single file. The .gz file format is not an archive format (i.e. it does not contain a collection of files/directories such as with the .zip, .rar, or .tar file formats). GZip is often combined with TAR to create a .tgz (or .tar.gz).

Note: It is possible for a .gz to contain more than one file, but this is very uncommon.

B4X

Dim success As Boolean = False

'  This example assumes the Chilkat API to have been previously unlocked.
'  See Global Unlock Sample for sample code.

Dim gzip As ChilkatGzip
gzip.Initialize("gzip")

'  File-to-file GZip:
'  Compress "hamlet.xml" to create "hamlet.xml.gz";
success = gzip.CompressFile("hamlet.xml", "hamlet.xml.gz")
If success = False Then
    Log(gzip.LastErrorText)
    Return
End If


'  File-to-file ungzip
'  Decompress "hamlet.xml.gz" to create "hamletOut.xml";
success = gzip.UncompressFile("hamlet.xml.gz", "hamletOut.xml")
If success = False Then
    Log(gzip.LastErrorText)
    Return
End If


'  File-to-string ungzip
'  Decompress the contents of a .gz directly to a string variable:
'  The 2nd argument indicates the charset of the character
'  data after it is decompressed.
Dim xmlStr As String
xmlStr = gzip.UncompressFileToString("hamlet.xml.gz", "utf-8")
If success = False Then
    Log(gzip.LastErrorText)
    Return
End If


Log(xmlStr)

'  The Chilkat GZip API provides much more flexibility than shown
'  here.  See the reference documentation at 
'  http://www.chilkatsoft.com/refdoc for more information.