ADTF  3.18.2
cFileCompression

Class for compressing and extracting files. More...

Public Types

enum  tCompressionAlgorithms { CA_Auto = 0 , CA_Bzip2 = 1 }
 Enumeration of compression algorithms.
 

Static Public Member Functions

static tResult Compress (const tChar *strInputFile, const tChar *strOutputFile=nullptr, tUInt32 nAlgo=CA_Auto)
 Compresses the given input file to the given output file. More...
 
static tResult Decompress (const tChar *strInputFile, const tChar *strOutputFile, tUInt32 nAlgo=CA_Auto)
 Decompresses the given input file to the given output file. More...
 

Detailed Description

Class for compressing and extracting files.

Definition at line 17 of file filecompression.h.

Member Function Documentation

◆ Compress()

static tResult Compress ( const tChar strInputFile,
const tChar strOutputFile = nullptr,
tUInt32  nAlgo = CA_Auto 
)
static

Compresses the given input file to the given output file.

Parameters
strInputFile[in] Filename of the input file.
strOutputFile[in] Filename of the output file (optional).
nAlgo[in] The compression algorithm that should be used.
Returns
Standard result.

◆ Decompress()

static tResult Decompress ( const tChar strInputFile,
const tChar strOutputFile,
tUInt32  nAlgo = CA_Auto 
)
static

Decompresses the given input file to the given output file.

Parameters
strInputFile[in] Filename of the input file.
strOutputFile[in] Filename of the output file.
nAlgo[in] The compression algorithm that should be used (Auto = extension detection).
Returns
Standard result.