FSCTL_SET_COMPRESSION IOCTL (winioctl.h)
Sets the compression state of a file or directory on a volume whose file system supports per-file and per-directory compression. You can use FSCTL_SET_COMPRESSION to compress or uncompress a file or directory on such a volume.
To perform this operation, call the DeviceIoControl function with the following parameters.
BOOL DeviceIoControl( (HANDLE) hDevice, // handle to file or directory FSCTL_SET_COMPRESSION, // dwIoControlCode (LPVOID) lpInBuffer, // input buffer (DWORD) nInBufferSize, // size of input buffer NULL, // lpOutBuffer 0, // nOutBufferSize (LPDWORD) lpBytesReturned, // number of bytes returned (LPOVERLAPPED) lpOverlapped // OVERLAPPED structure );
The LZNT1 compression algorithm is the only compression algorithm implemented. As a result, the LZNT1 compression algorithm is used as the DEFAULT compression method.
If the file system of the volume containing the specified file or directory does not support per-file or per-directory compression, the operation fails.
The compression state change of the file or directory occurs synchronously with the call to DeviceIoControl.
To retrieve the compression state of a file or directory, use the FSCTL_GET_COMPRESSION control code.
To retrieve the compression attribute of a file or directory, use the GetFileAttributes function. The compression attribute indicates whether a file or directory is compressed. The compression state indicates whether a file or directory is compressed and, if it is, the format of the compressed data.
Directories are not actually compressed by this operation. Rather, the operation sets the default state for files created in the directory to be compressed.
Note that the time stamps may not be updated correctly for a remote file. To ensure consistent results, use unbuffered I/O.
File compression is supported for files of a maximum uncompressed size of 30 gigabytes.
In Windows 8 and Windows Server 2012, this code is supported by the following technologies.
|Server Message Block (SMB) 3.0 protocol||Yes|
|SMB 3.0 Transparent Failover (TFO)||No|
|SMB 3.0 with Scale-out File Shares (SO)||No|
|Cluster Shared Volume File System (CsvFS)||See comment|
|Resilient File System (ReFS)||No|
CsvFs does not support making a directory compressed. CsvFs allows making file compressed only when the file is opened exclusively by a node. SMB 3.0 Transparent Failover and Scale-Out does not support NTFS compressed files. The FSCTL call is not blocked, but is unsupported."CreateFileTransacted.
For more information about transactions, see Transactional NTFS.
|Minimum supported client||Windows XP [desktop apps only]|
|Minimum supported server||Windows Server 2003 [desktop apps only]|
|Header||winioctl.h (include Windows.h)|