JCL Help:NtfsSetDefaultFileCompression
JCL Help: NtfsSetDefaultFileCompression Function
Search in JCL Help
Search in all projects
Summary
Sets the default compression state of a directory.
Pascal
procedure NtfsSetDefaultFileCompression(const Directory: string; const State: TFileCompressionState);
Parameters
| Parameters | Description |
| const Directory: string | The name of the directory for which you want to set the compression state. |
| const State: TFileCompressionState | The desired compression state. |
Description
NtfsSetDefaultFileCompression sets the default compression state for files created in 'Directory'. 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 NtfsSetFileCompression NtfsSetDirectoryTreeCompression NtfsSetPathCompression NtfsGetCompression
About
Unit
Donator
Robert Rossmair
Notes
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. This operation does not alter the compression state of files already existing in the directory. To change the compression state of a directory and all of its contents, use NtfsSetDirectoryTreeCompression. NtfsSetDefaultFileCompression will raise an EJclInvalidArgument exception if the 'Directory' parameter does not denote a directory.
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
