CEZGZipToFile Class Reference

#include <ezgzip.h>

Link against: ezlib.lib

class CEZGZipToFile : public CBase

Inherits from

CEZGZipToFile

Public Member Functions
	~CEZGZipToFile()
IMPORT_C TBool	InflateL()
IMPORT_C CEZGZipToFile *	NewL(RFs &, const TDesC &, RFile &, TInt)
IMPORT_C CEZGZipToFile *	NewLC(RFs &, const TDesC &, RFile &, TInt)
IMPORT_C void	ResetL(RFs &, const TDesC &, RFile &, TInt)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

A CEZGZipToFile object allows de-compression of a compressed file. The name of the compressed file is passed into the constructor along with a target file to contain the uncompressed data. The file is uncompressed by calling the InflateL() function.

Constructor & Destructor Documentation

~CEZGZipToFile ( )

~CEZGZipToFile

(

)

Member Function Documentation

InflateL ( )

IMPORT_C TBool

InflateL

(

)

De-compresses the current zip file in stages. The function needs to called again until the de-compression is finalised, in which case it will return EFalse - for example...

while ( decompressor->InflateL() )
	{
	// No action required
	}

leave: KEZlibErrBadGZipCrc Invalid CRC check

leave: ... Any of the system wide error codes

Returns: ETrue if the de-compression is not complete, and function must be called again EFalse if the de-compression is finalised

NewL ( RFs &, const TDesC &, RFile &, TInt )

IMPORT_C CEZGZipToFile *	NewL	(	RFs &	aRfs,
			const TDesC &	aGzFileName,
			RFile &	aOutput,
			TInt	aBufferSize = 0x8000
		)	[static]

Creates a new CEZGZipToFile object

Parameter	Description
aRfs	open file server session
aGzFileName	name of the file to be de-compressed
aOutput	the target file to hold the un-compressed data
aBufferSize	required size of buffers

Returns: a pointer to the new CEZGZipToFile object

NewLC ( RFs &, const TDesC &, RFile &, TInt )

IMPORT_C CEZGZipToFile *	NewLC	(	RFs &	aRfs,
			const TDesC &	aGzFileName,
			RFile &	aOutput,
			TInt	aBufferSize = 0x8000
		)	[static]

Creates a new CEZGZipToFile object and leaves it on the CleanupStack

Parameter	Description
aRfs	open file server session
aGzFileName	name of the file to be de-compressed
aOutput	the target file to hold the un-compressed data
aBufferSize	required size of buffers

Returns: a pointer to the new CEZGZipToFile object, left on the CleanupStack

ResetL ( RFs &, const TDesC &, RFile &, TInt )

IMPORT_C void	ResetL	(	RFs &	aRfs,
			const TDesC &	aGzFileName,
			RFile &	aOutput,
			TInt	aBufferSize = 0x8000
		)

Quits the current de-compression operation and restarts with the specified arguments

leave: ... Any of the system wide error codes

Parameter	Description
aRfs	open file server session
aGzFileName	name of the file to be de-compressed
aOutput	the target file to hold the un-compressed data
aBufferSize	required size of buffers