Xceed Zip Compression Library Documentation
RequiredFileAttributes property
Xceed Zip control reference > Xceed Zip control properties > RequiredFileAttributes property

RequiredFileAttributes property

Description

The RequiredFileAttributes property lets you limit the processing of files to only those files that have specific file attributes on. This property affects the list of files specified in the FilesToProcess property.

Files that do not have the required file attributes will be tagged as "excluded" when the ZipPreprocessingFile or UnzipPreprocessingFile event is triggered, and will not be processed unless you change the value of the excluded parameter to False during the event.

To specify multiple file attributes that must be on, set the RequiredFileAttributes property equal to the sum of the values for each required file attribute.

Data type

xcdFileAttributes

Possible values

Enum Value Meaning
xfaNone 0 No specific attributes must be on in order to process files.
xfaReadOnly 1 Read-only attribute required.
xfaHidden 2 Hidden attribute required.
xfaSystem 4 System attribute required.
xfaVolume 8 Volume Label attribute required.
xfaFolder 16 Folder / directory attribute required.
xfaArchive 32 Archive bit attribute required.
xfaTemporary 256 Temporary attribute required.
xfaSparseFile 512 Sparse file attribute required.
xfaReparsePoint 1024 Reparse point attribute required.
xfaCompressed 2048 Compressed attribute required.
xfaOffline 4096 Offline attribute required.
xfaNotContentIndexed 8192 Content not indexed attribute required.
xfaEncrypted 16384 Encrypted attribute required.
xfaVirtual 65536 Virtual file attribute required.

Default value

xfaNone

Declaration (DLL API)  

DWORD XzGetRequiredFileAttributes( HXCEEDZIP hZip )
void XzSetRequiredFileAttributes( HXCEEDZIP hZip, DWORD dwValue )

Applicable methods

Zip, Unzip, ListZipContents, PreviewFiles, RemoveFiles

Related topics

The ExcludedFileAttributes property lets you limit the processing of files to only those files that don't have specific file attributes on, as opposed to only processing files that have these attributes on.

If you want to create your own, special filters in order to limit which files are processed, you can use the ZipPreprocessingFile or UnzipPreprocessingFile events to specifically exclude files (just set the excluded parameter whenever you want to exclude a file).