Collapse all Symbian^3 Application Developer Library

CEZGZipToFile Class Reference

class CEZGZipToFile : public CBase

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.

Inherits from

CEZGZipToFile
- CBase

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 )

Private Member Functions
	CEZGZipToFile ()
void	ConstructL ( RFs &, const TDesC &, RFile &, TInt )
void	InitialiseBufManL ( 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()

Private Attributes
CEZGzipToFileBM *	iBufferManager
CEZDecompressor *	iDecompressor
RFile	iGZipFile
TEZGZipHeader	iHeader
TEZGZipTrailer	iTrailer

Constructor & Destructor Documentation

CEZGZipToFile()

CEZGZipToFile

(

)

[private]

~CEZGZipToFile()

~CEZGZipToFile

(

)

Member Functions Documentation

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

void	ConstructL	(	RFs &	aRfs,
			const TDesC &	aGzFileName,
			RFile &	aOutput,
			TInt	aBufferSize
		)	[private]

Parameters

RFs & aRfs
const TDesC & aGzFileName
RFile & aOutput
TInt aBufferSize

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

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

void	InitialiseBufManL	(	RFs &	aRfs,
			const TDesC &	aGzFileName,
			RFile &	aOutput,
			TInt	aBufferSize
		)	[private]

Parameters

RFs & aRfs
const TDesC & aGzFileName
RFile & aOutput
TInt aBufferSize

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

Parameters

RFs & aRfs	open file server session
const TDesC & aGzFileName	name of the file to be de-compressed
RFile & aOutput	the target file to hold the un-compressed data
TInt aBufferSize = 0x8000	required size of buffers

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

Parameters

RFs & aRfs	open file server session
const TDesC & aGzFileName	name of the file to be de-compressed
RFile & aOutput	the target file to hold the un-compressed data
TInt aBufferSize = 0x8000	required size of buffers

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

Parameters

RFs & aRfs	open file server session
const TDesC & aGzFileName	name of the file to be de-compressed
RFile & aOutput	the target file to hold the un-compressed data
TInt aBufferSize = 0x8000	required size of buffers