Delphi Database, Delphi Components from ComponentAce

TZipForge.Options
TZipForge Example

Top

Specifies the ZipForge options.

type TZFOptions = class(TPersistent)
published
property Recurse: Boolean default True;
property CreateDirs: Boolean default True;
property FlushBuffers: Boolean default True;
property ReplaceReadOnly: Boolean default True;
property SetAttributes: Boolean default True;
property SearchAttr: Word default 63;
property StorePath: TZFStorePath default spRelativePath;
property ShareMode: TZFFileShareMode default smShareDenyNone;
property OverwriteMode: TZFOverwriteMode default omAlways;
property OEMFileNames: Boolean default True;
end;

property Options: TZFOptions;

Description
Specify neccessary Options for ZipForge operations.

Recurse specifies if FindFirst, AddFiles, ExtractFiles, TestFiles, MoveFiles, UpdateFiles and DeleteFiles methods will search files recursively. This means that if some folder meets search conditions then all files and directories within this folder will be scanned. For example, if you set Recurse to true and call AddFiles('C:\*.*',faAnyFile) all files and folders located on disk C: will be added to the archive.

Set CreateDirs to True if you need to extract files with creating all neccessary folders.

FlushBuffers specifies whether the file buffers will be flushed after archive file modification and after extracting files from archive.

If ReplaceReadOnly set to True it means that all existing read only files will be replaced with the files being extracted by ExtractFiles.

SetAttributes determines whether attributes stored within the archive will be applied to files being extracted by ExtractFiles.

SearchAttr specifies the special files to include in addition to all normal files for FindFirst, AddFiles, ExtractFiles, TestFiles, MoveFiles, UpdateFiles and DeleteFiles methods variant without parameters. This option 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.
If you would like to process files without Archive attribute, you should specify $80 constant in addition to other attributes combination.
If NTFS files created by another user are to be added into archive, then it will be necessary to add $2000 constant to SearchAttr.
If compressed NTFS files are to be added into archive, then it will be necessary to add $800 constant to SearchAttr.

StorePath defines how path infromation will be stored for the file or directory within the archive file. This option applies to AddFiles, MoveFiles, UpdateFiles methods.

ShareMode specifies how the files being added to the archive will be opened for simulatenous access. Set this option before calling AddFiles, MoveFiles or UpdateFiles .

OverwriteMode specifies whether extracted files will overwrite existing files. Set this option before calling ExtractFiles, AddFiles, MoveFiles or UpdateFiles.

OEMFileNames specifies whether file names strored in archive are translated into OEM character set.

Apr 18, 2024