VB example Delphi example VC++ example

Description

The Unzip method uncompresses files that are stored in a zip file and recreates them into the folder specified by the UnzipToFolder property.

The zip file to unzip from must be specified by setting the ZipFilename property.

The files to unzip must be specified by setting the FilesToProcess property. If the FilesToProcess property is left empty, then all the files in the zip file will be unzipped. Use the filtering properties when you need to limit processing to only files with specific attributes, sizes, dates, etc.

Method Unzip() As xcdError 

int XzUnzip( HXCEEDZIP hZip ) 

Return values

A return value of type xcdError is returned. Only the return value of xerSuccess indicates that the method has been completed successfully. See the error codes topic for a list of possible return values.

Remarks

When unzipping an encrypted zip file, only the  EncryptionPassword property must be set. The EncryptionStrength and EncryptionMethod properties will be ignored as it is not necessary to know either values when unzipping and encrypted zip file.

Applicable properties

Abort, EncryptionPassword, FilesToProcess and the filtering properties, PreservePaths, ProcessSubfolders, the SkipIf* properties, UnzipToFolder, ZipFilename and ExtraHeaders.

Events triggered

InsertDisk, UnzipPreprocessingFile, SkippingFile, FileStatus, GlobalStatus, UnzippingMemoryFile, Warning, InvalidPassword, ZipComment and ProcessCompleted.

Things you should consider

• Do you want to preserve existing files?Set the SkipIfExisting property to true.