EZGZipFile Class Reference

#include <ezgzip.h>

Link against: ezlib.lib

class EZGZipFile

Public Attributes
const TUint8	ID1
const TUint8	ID2

Public Member Enumerations
enum	anonymous { ENotGZipFile, EInvalidCompressionMethod, EBadGZipHeader, EBadGZipTrailer, EBadGZipCrc }
enum	anonymous { EFText, EFHcrc, EFExtra, EFName, EFComment }

Public Member Functions
IMPORT_C TBool	IsGzipFile(RFs &, const TDesC &)
IMPORT_C TBool	IsGzipFileL(RFs &, const TDesC &)
IMPORT_C void	LocateAndReadTrailerL(RFs &, const TDesC &, TEZGZipTrailer &)
IMPORT_C void	ReadHeaderL(RFile &, TEZGZipHeader &)
IMPORT_C void	ReadTrailerL(RFile &, TEZGZipTrailer &)
IMPORT_C void	WriteHeaderL(RFile &, TEZGZipHeader &)
IMPORT_C void	WriteTrailerL(RFile &, TEZGZipTrailer &)

Detailed Description

The EZGZipFile class handles writing / reading of headers and trailers to / from zip files

Member Attribute Documentation

ID1

const TUint8

ID1

[static]

First of the header ID pair

ID2

const TUint8

ID2

[static]

Second of the header ID pair

Member Enumeration Documentation

Enum anonymous

Zip file error codes

Enumerator	Value	Description
ENotGZipFile	KEZlibErrNotGZipFile
EInvalidCompressionMethod	KEZlibErrInvalidCompression
EBadGZipHeader	KEZlibErrBadGZipHeader
EBadGZipTrailer	KEZlibErrBadGZipTrailer
EBadGZipCrc	KEZlibErrBadGZipCrc

Enum anonymous

Flags to determine which part of the header / trailer is being written

Enumerator	Value	Description
EFText	0
EFHcrc	1
EFExtra	2
EFName	3
EFComment	4

Member Function Documentation

IsGzipFile ( RFs &, const TDesC & )

IMPORT_C TBool	IsGzipFile	(	RFs &	aRfs,
			const TDesC &	aFname
		)	[static]

DeprecatedInterface is deprecated because it is unsafe as it may leave. It is available for backward compatibility reasons only.

IsGzipFileL ( RFs &, const TDesC & )

IMPORT_C TBool	IsGzipFileL	(	RFs &	aRfs,
			const TDesC &	aFname
		)	[static]

Determine if the given file is a valid zip file

Parameters
aRfs	file server session
aFname	name of the file to check

Return Value: ETrue if the file is valid zip file, EFalse otherwise

Leave Codes
...	Any of the system wide error codes

LocateAndReadTrailerL ( RFs &, const TDesC &, TEZGZipTrailer & )

IMPORT_C void	LocateAndReadTrailerL	(	RFs &	aRfs,
			const TDesC &	aFname,
			TEZGZipTrailer &	aTrailer
		)	[static]

Find the zip trailer within the specified file, and read it into the TEZGZipTrailer object

Parameters
aRfs	file server session
aFname	the file to read from
aTrailer	the target trailer object

Leave Codes
KEZlibErrBadGZipHeader	Invalid zip header
...	Any of the system wide error codes

ReadHeaderL ( RFile &, TEZGZipHeader & )

IMPORT_C void	ReadHeaderL	(	RFile &	aFile,
			TEZGZipHeader &	aHeader
		)	[static]

Read the zip header from the specified zip file into the TEZGZipHeader object

Parameters
aFile	the zip file to read from
aHeader	the target header object

Leave Codes
KEZlibErrBadGZipHeader	invalid zip header
...	Any of the system wide error codes

ReadTrailerL ( RFile &, TEZGZipTrailer & )

IMPORT_C void	ReadTrailerL	(	RFile &	aFile,
			TEZGZipTrailer &	aTrailer
		)	[static]

Read the zip trailer from the specified zip file into the TEZGZipTrailer object

Parameters
aFile	the zip file to read from
aTrailer	the target trailer object

Leave Codes
KEZlibErrBadGZipTrailer	invalid zip trailer
...	Any of the system wide error codes

WriteHeaderL ( RFile &, TEZGZipHeader & )

IMPORT_C void	WriteHeaderL	(	RFile &	aFile,
			TEZGZipHeader &	aHeader
		)	[static]

Write the zip header to the specified file

Parameters
aFile	the file to write to
aHeader	the header object to write to the file

Leave Codes
...	Any of the system wide error codes

WriteTrailerL ( RFile &, TEZGZipTrailer & )

IMPORT_C void	WriteTrailerL	(	RFile &	aFile,
			TEZGZipTrailer &	aTrailer
		)	[static]

Write the zip trailer to the specified file

Parameters
aFile	the file to write to
aTrailer	the trailer object to write to the file

Leave Codes
...	Any of the system wide error codes