Overview Module Function Class Tea 3.1.0 Reference Documentation
© 2002 PDM&FC

Class TZipFile

Instances of TZipFile give access to the entries of a given ZIP file. It is possible to access the names of all the entries in the ZIP file and it is possible to access an entry as a TInput.

Method Summary
close
         Closes the ZIP file currently opened.
constructor [pathName]
         Initializes the object internal state and optionaly opens a ZIP file.
getEntryNames
         Fetches the names of all entries in the currently opened ZIP file.
getInput
         Fetches the contents of one ZIP file entry as a TInput.
isDirectory entryName
         Checks if a given entry is a directory.
open pathName
         Opens an existing ZIP file.

Method Detail

close

TZipFile close

Closes the ZIP file currently opened.

Returns:
A reference to the object for which the method was called.

If there is no currently opened ZIP file then this method has no effect.

constructor

TZipFile constructor [pathName]

Initializes the object internal state and optionaly opens a ZIP file.

Parameters:
pathName - String object representing the path name of a ZIP file.

If no pathName argument is given this TZipFile is closed and the open method will eventually have to be called to open a particular ZIP file.

getEntryNames

TZipFile getEntryNames

Fetches the names of all entries in the currently opened ZIP file.

Returns:
Returns a list of strings where each element is the name of one of the entries in the ZIP file.


getInput

TZipFile getInput

Fetches the contents of one ZIP file entry as a TInput.

Returns:
An opened TInput object.


isDirectory

TZipFile isDirectory entryName

Checks if a given entry is a directory.

Parameters:
entryName - String object representing the name of an entry in the currently opened ZIP file.
Returns:
True if entryName corresponds to an entry that is a directory. False otherwise.

If there is no entry named entryName in the ZIP file then a runtime error will occur.

open

TZipFile open pathName

Opens an existing ZIP file.

Parameters:
pathName - String object representing the path name of a ZIP file.
Returns:
A reference to the object for which the method was called.

If a ZIP file was previously opened then it is automatically closed prior to opening the new ZIP file.


Overview Module Function Class Tea 3.1.0 Reference Documentation
© 2002 PDM&FC
Report a bug or request new features
© 2002