JCL Help:NtfsSetPathCompression
JCL Help: NtfsSetPathCompression Function
Search in JCL Help
Search in all projects
Summary
Sets the compression state for all files specified by Path.
Pascal
procedure NtfsSetPathCompression(const Path: string; const State: TFileCompressionState; Recursive: Boolean);
Parameters
| Parameters | Description |
| const State: TFileCompressionState | The desired compression state. |
| Recursive: Boolean | Determines whether subdirectories are affected. |
| Directory | The name of the directory for which you want to set the compression state. |
Description
NtfsSetPathCompression sets the compression state for all files in the directory specified by Path which match the file name implied by Path. When Recursive is set, subdirectories are processed as well. The underlying filesystem must support per stream compression or this function will fail. Currently only LZNT1 is supported as the compression format but this may change in future releases of the Windows operating system.
See Also
TFileCompressionState NtfsSetDefaultFileCompression NtfsSetFileCompression NtfsSetDirectoryTreeCompression NtfsGetCompression
About
Unit
Donator
Robert Rossmair
Notes
The file compression default (compare NtfsSetDefaultFileCompression) for the involved directories is affected only if Path denotes a directory. If, in addition, Recursive is set, NtfsSetPathCompression will work exactly like NtfsSetDirectoryTreeCompression(Path, State). The underlying filesystem must support per stream compression. Currently that means the specified file or directory must reside on an NTFS formatted partition. The FAT filesystem does not support compression.
Contribute to this help topic
This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page
