Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIZipReader Interface Reference

import "nsIZipReader.idl";

Inheritance diagram for nsIZipReader:
Inheritance graph
[legend]
Collaboration diagram for nsIZipReader:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void init (in nsIFile zipFile)
 Initializes a zip reader after construction.
void open ()
 Opens a zip reader.
void close ()
 Closes a zip reader.
void test (in string aEntryName)
 Tests the integrity of the archive by performing a CRC check on each item expanded into memory.
void extract (in string zipEntry, in nsIFile outFile)
 Extracts a zip entry into a local file specified by outFile.
nsIZipEntry getEntry (in string zipEntry)
 Returns a nsIZipEntry describing a specified zip entry.
nsISimpleEnumerator findEntries (in string aPattern)
 Returns a simple enumerator whose elements are of type nsIZipEntry.
nsIInputStream getInputStream (in string zipEntry)
 Returns an input stream containing the contents of the specified zip entry.

Public Attributes

readonly attribute nsIFile file

Detailed Description

Definition at line 61 of file nsIZipReader.idl.


Member Function Documentation

Closes a zip reader.

Subsequent attempts to extract files or read from its input stream will result in an error.

void nsIZipReader::extract ( in string  zipEntry,
in nsIFile  outFile 
)

Extracts a zip entry into a local file specified by outFile.

Returns a simple enumerator whose elements are of type nsIZipEntry.

Returns a nsIZipEntry describing a specified zip entry.

Returns an input stream containing the contents of the specified zip entry.

Initializes a zip reader after construction.

Opens a zip reader.

void nsIZipReader::test ( in string  aEntryName)

Tests the integrity of the archive by performing a CRC check on each item expanded into memory.

If an entry is specified the integrity of only that item is tested. If NULL is passed in the inetgrity of all items in the archive are tested.


Member Data Documentation

Definition at line 68 of file nsIZipReader.idl.


The documentation for this interface was generated from the following file: