Xceed Zip Compression Library Documentation
RemoveFiles method
Xceed Zip control reference > Xceed Zip control methods > RemoveFiles method

Description

The RemoveFiles method removes files from a zip file.

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

The files to remove must be specified by setting the FilesToProcess property. The FilesToExclude property and the filtering properties are also consulted to allow you to limit processing to only specific types of files.

The RemoveFiles method will not operate on spanned zip files.

Declaration (ActiveX)  
Method RemoveFiles() As xcdError 
Declaration (DLL API)  
int XzRemoveFiles( 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

Be careful when the ProcessSubfolders property is set to true – specifying "*" in FilesToProcess will in this case erase all files from the zip file.

Applicable properties

Abort, FilesToProcess and the filtering properties, ProcessSubfolders, TempFolder and the UseTempFile property which must be set to True.

Events triggered

RemovingFile, GlobalStatus

Related topics

Related topics