Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: EZGzip.h
Link against: ezlib.lib

Class EZGZipFile

class EZGZipFile;

Description

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

Members

Defined in EZGZipFile:
EBadGZipCrc, EBadGZipHeader, EBadGZipTrailer, EFComment, EFExtra, EFHcrc, EFName, EFText, EInvalidCompressionMethod, ENotGZipFile, ID1, ID2, IsGzipFile(), IsGzipFileL(), LocateAndReadTrailerL(), ReadHeaderL(), ReadTrailerL(), WriteHeaderL(), WriteTrailerL(), anonymous, anonymous


Member functions


ReadHeaderL()

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

Description

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

Parameters

RFile &aFile

the zip file to read from

TEZGZipHeader &aHeader

the target header object

Leave codes

KEZlibErrBadGZipHeader

invalid zip header

...

Any of the system wide error codes


WriteHeaderL()

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

Description

Write the zip header to the specified file

Parameters

RFile &aFile

the file to write to

TEZGZipHeader &aHeader

the header object to write to the file

Leave codes

...

Any of the system wide error codes


ReadTrailerL()

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

Description

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

Parameters

RFile &aFile

the zip file to read from

TEZGZipTrailer &aTrailer

the target trailer object

Leave codes

KEZlibErrBadGZipTrailer

invalid zip trailer

...

Any of the system wide error codes


WriteTrailerL()

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

Description

Write the zip trailer to the specified file

Parameters

RFile &aFile

the file to write to

TEZGZipTrailer &aTrailer

the trailer object to write to the file

Leave codes

...

Any of the system wide error codes


LocateAndReadTrailerL()

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

Description

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

Parameters

RFs &aRfs

file server session

const TDesC &aFname

the file to read from

TEZGZipTrailer &aTrailer

the target trailer object

Leave codes

KEZlibErrBadGZipHeader

Invalid zip header

...

Any of the system wide error codes


IsGzipFile()

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

Description

Parameters

RFs &aRfs

const TDesC &aFname

Return value

TBool


IsGzipFileL()

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

Description

Determine if the given file is a valid zip file

Parameters

RFs &aRfs

file server session

const TDesC &aFname

name of the file to check

Return value

TBool

ETrue if the file is valid zip file, EFalse otherwise

Leave codes

...

Any of the system wide error codes

[Top]


Member enumerations


Enum anonymous

n/a

Description

Zip file error codes

ENotGZipFile

EInvalidCompressionMethod

EBadGZipHeader

EBadGZipTrailer

EBadGZipCrc


Enum anonymous

n/a

Description

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

EFText

EFHcrc

EFExtra

EFName

EFComment

[Top]


Member data


ID1

const TUint8 ID1;

Description

First of the header ID pair


ID2

const TUint8 ID2;

Description

Second of the header ID pair