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

Description

The FilesToProcess property is used to provide a list of files or folders to be processed by the Zip, Unzip, RemoveFiles, PreviewFiles, ListZipContents and TestZipFile methods.

Wildcards can be used to match multiple files, and folders can be specified by adding a backslash ("\") after the path and folder name. 

If the ProcessSubfolders property is left to its default value of false, all subfolders will also be scanned for the specified file(s) even if wildcards are not used. For example, if  "C:\test.txt" is specified in the FilesToProcess property and the ProcessSubFolders property is set to true, all "test.txt" files found on the "C:\" drive will be added to the zip file. Folders specified with the backslash after them will include their entire contents.

When using the Zip or PreviewFiles methods, the FilesToProcess property must contain a list of files or folders to zip up (or preview) that match files accessible on the current machine or network. For these methods, the files to process can be specified either with absolute paths , relative paths or without paths. The manner that files are specified in the FilesToProcess property determines what portion of the path will be stored in the zip file along with the filename. See the controlling how paths are stored topic for details.

When using the Unzip, RemoveFiles, ListZipContents or TestZipFile methods, the file names you provide to the FilesToProcess property must match with the path and filename information stored in the Zip file. Keep in mind that drive letters are not normally stored in a zip file. If you are unsure of what path information is stored in the zip file, set the PreservePaths property to False. This will cause all path information stored in the zip file to be ignored, and will allow you to specify only file names in the FilesToProcess property.

If you leave the FilesToProcess property empty and use the Unzip, ListZipContents or the TestZipFile methods, all the files in the zip file will be processed.

Data type

String. The FilesToProcess property is a single string that can contain multiple files and wildcards to process. When specifying multiple files to process, each file must be separated with the CR character (ASCII 13), the LF character (ASCII 10), the CR+LF characters or the vertical bar "|" character. For cleaner code, use the AddFilesToProcess method when you need to specify multiple files in the FilesToProcess property – it automatically handles the task of separating items with the return character.

Default value

Empty

Declaration (DLL API)  

UINT XzGetFilesToProcess( HXCEEDZIP hZip, TCHAR* pszBuffer, UINT uMaxLength )
void XzSetFilesToProcess( HXCEEDZIP hZip, const TCHAR* pszValue )

Remarks

When using relative paths to zip or preview files, the paths must be relative to the application's current directory , or the folder specified in the BasePath property if it has been set.
 

The length of the file names must not exceed 260 characters (MAX_PATH).

You can append "<L>" to each item in the FilesToProcess property. This will prevent the component from recursing into sub-directories that are name surrogates (symbolic links, hard links, junctions points, volume mount points) for that entry. Normal directories will still be recursed into depending on the value of the ProcessSubFolders property.

Applicable methods

Zip, Unzip, ListZipContents, PreviewFiles, RemoveFiles

Related topics

You can use the FilesToExclude property if you want to exclude specific file names or paths from the list of files you have specified in the FilesToProcess property.

To exclude files based on criteria other than file names, refer to the filtering properties.

See Also