Delphi Database, Delphi Components from ComponentAce

TZipForge.ExtractFiles
TZipForge Example1 Example2

Top

Extracts files from the archive.

procedure ExtractFiles; overload;
procedure ExtractFiles(
         FileMask:    String;
         SearchAttr:    Word = faAnyFile;
         ExclusionMask: String = ''); overload;

Description
Use ExtractFiles to extract files from the open archive file. If Options.Recurse is set to True, ExtractFiles will search files recursively.

ExtractFiles variant without parameters uses FileMasks, ExclusionMasks and Options.SearchAttr properties to specify search conditions and to exclude files from add operation.
ExtractFiles variant with parameters uses procedure parameters and ignores FileMasks, ExclusionMasks and Options.SearchAttr properties.

The FileMask parameter is the directory and file name mask, including wildcard characters. For example, 'TEST\*.*' specifies all files in the TEST directory stored within the archive file. All files that meets FileMask and SearchAttr will be extracted from the archive.If FileMask is a blank string, no files will be extracted.

The SearchAttr parameter specifies the special files to include in addition to all normal files. This parameter is similar to the Attr parameter in FindFirst function from SysUtils unit. You can set it to any combination of faReadOnly, faHidden, faSysFile, faVolumeID, faDirectory, faArchive constants defined in SysUtils or value faAnyFile meaning that any file meets search condition.

The ExclusionMask specifies files to be excluded from extract operation.

Note: Any transaction must be finished before calling ExtractFiles. Otherwise an exception will be raised. Also if some other errors occurs an exception will be raised. Write an OnProcessFileFailure event handler to perform your own error handling.

Note: Use ExtractCorruptedFiles property to specify whether extracting of corrupted files is allowed.

Note: If you need to change the name of the extracted file, use OnExtractFile event handler.

Nov 23, 2024