VB example Delphi example

Description

The ListZipContents method lists the files contained in a zip file by triggering the ListingFile event for each file being listed. The provided listing contains detailed information on each file. The ProcessCompleted event provides the statistics for the entire group of files listed.

The zip file to list must be specified by the ZipFilename property.

If the FilesToProcess property is empty, all files in the zip file will be listed, except those that are excluded by the filtering properties.

You can use the GetZipContents method instead of the ListZipContents method if you prefer to obtain the listing of files by receiving a collection object instead of having an event triggered.

Method ListZipContents() As xcdError 

int XzListZipContents( 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

The files listed by the ListZipContents method can be limited by the FilesToProcess, FilesToExclude and the filtering properties – but are not affected by the SkipIf* properties. Therefore, if you don't use the SkipIf* properties, the ListZipContents method can be used to obtain the complete list of files that will end up being processed by a call to the Unzip method.

Applicable properties

Abort, ZipFilename, FilesToProcess, ProcessSubfolders and the filtering properties.

Events triggered

ListingFile, InsertDisk, ZipContentsStatus, ZipComment, Warning and ProcessCompleted

Related topics

The PreviewFiles method is the equivalent of the ListZipContents method, but for files on disk – not already in a zip file.