Close()
Previous  Top  Next

:Close() - Close the Zip File.

Syntax

:Close([<cZipFileComment>]) --> Self  

Parameters

<cZipFileComment>  
<cZipFileComment> optionally specifies the value of the (Global) Zip File Comment to be saved.  
It defaults to the current value of the instance variable :FileComment.  

Returns

This method returns the object executing the method.  

Description

This method closes the Zip File, and re-initializes the XbZLibZip object. If any Central Directory entries in the Zip File had been changed since the Zip File was opened, or if the (Global) Zip File Comment was changed, the Central Directory of the Zip File will first be saved/updated. In addition, any open Log File will be closed and all instance variables (including callbacks) of the XbZLibZip object will be reset. For the default values of all protected instance variables, see the :Init() method in the source code.  

Example

Close the currently open Zip File and Save (its Central Directory) including a new (Global) Zip File Comment:  
 
oZip:Close('File last updated by Andreas Gehrs-Pahl.')