Interface nsIZipReaderType

Hierarchy

Properties

file: nsIFile

The file that represents the zip with which this zip reader was initialized. This will be null if there is no underlying file.

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

  • Closes a zip reader. Subsequent attempts to extract files or read from its input stream will result in an error.

    Subsequent attempts to access a nsIZipEntry obtained from this zip reader will cause unspecified behavior.

    Returns void

  • Extracts a zip entry into a local file specified by outFile. The entry must be stored in the zip in either uncompressed or DEFLATE-compressed format for the extraction to be successful. If the entry is a directory, the directory will be extracted non-recursively.

    Parameters

    • zipEntry: string
    • outFile: nsIFile

    Returns void

  • Returns a string enumerator containing the matching entry names.

    Throws

    NS_ERROR_ILLEGAL_VALUE on many but not all invalid aPattern values.

    Parameters

    • aPattern: string

      A regular expression used to find matching entries in the zip file. Set this parameter to null (javascript) or ""_ns (c++) or "*" to get all entries; otherwise, use the following syntax:

      o * matches anything o ? matches one character o $ matches the end of the string o [abc] matches one occurrence of a, b, or c. The only character that must be escaped inside the brackets is ]. ^ and - must never appear in the first and second positions within the brackets, respectively. (In the former case, the behavior specified for '[^az]' will happen.) o [a-z] matches any character between a and z. The characters a and z must either both be letters or both be numbers, with the character represented by 'a' having a lower ASCII value than the character represented by 'z'. o [^az] matches any character except a or z. If ] is to appear inside the brackets as a character to not match, it must be escaped. o patpat2 returns matches to the pattern 'pat' which do not also match the pattern 'pat2'. This may be used to perform filtering upon the results of one pattern to remove all matches which also match another pattern. For example, because '' matches any string and 'z' matches any string containing a 'z', 'z' will match all strings except those containing a 'z'. Note that a pattern may not use '' multiple times, so a string such as '*zy' is not a valid pattern. o (foo|bar) will match either the pattern foo or the pattern bar. Neither of the patterns foo or bar may use the 'patpat2' syntax described immediately above. o \ will escape a special character. Escaping is required for all special characters unless otherwise specified. o All other characters match case-sensitively.

      An aPattern not conforming to this syntax has undefined behavior.

    Returns nsIUTF8StringEnumerator

  • Returns a nsIZipEntry describing a specified zip entry.

    Parameters

    • zipEntry: string

    Returns nsIZipEntry

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

    Parameters

    • zipEntry: string

      the name of the entry to open the stream from

    Returns nsIInputStream

  • Returns an input stream containing the contents of the specified zip entry. If the entry refers to a directory (ends with '/'), a directory stream is opened, otherwise the contents of the file entry is returned.

    Parameters

    • aJarSpec: string

      the Spec of the URI for the JAR (only used for directory streams)

    • zipEntry: string

      the name of the entry to open the stream from

    Returns nsIInputStream

  • Checks whether the zipfile contains an entry specified by entryName.

    Parameters

    • zipEntry: string

    Returns boolean

  • Opens a zip file for reading. It is allowed to open with another file, but it needs to be closed first with close().

    Parameters

    • zipFile: nsIFile

    Returns void

  • Opens a zip file inside a zip file for reading.

    Parameters

    • zipReader: nsIZipReader
    • zipEntry: string

    Returns void

  • 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 (javascript) or ""_ns (c++) is passed in the integrity of all items in the archive are tested.

    Parameters

    • aEntryName: string

    Returns void

Generated using TypeDoc