Win32 File API SetFileAttributes function
Download EaseFilter Monitor, Control and Encryption Filter Driver SDK Setup File Download EaseFilter Monitor, Control and Encryption Filter Driver SDK Zip File
Sets the attributes for a file or directory.
To perform this operation as a transacted operation, use the SetFileAttributesTransacted function.
Syntax
BOOL SetFileAttributes(
LPCWSTR lpFileName,
DWORD dwFileAttributes
);
Parameters
lpFileName
The name of the file whose attributes are to be set.
In the ANSI version of this function, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, call the Unicode version of the function (SetFileAttributesW) and prepend "\?" to the path. For more information, see File Names, Paths, and Namespaces.
dwFileAttributes
The file attributes to set for the file.
This parameter can be one or more values, combined using the bitwise-OR operator. However, all other values override FILE_ATTRIBUTE_NORMAL.
Not all attributes are supported by this function. For more information, see the Remarks section.
The following is a list of supported attribute values.
Return Value
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
Remarks
The following table describes how to set the attributes that cannot be set using SetFileAttributes. For a complete list of all file attribute values and their descriptions, see File Attribute Constants.
| Attribute | How to Set |
|---|---|
| FILE_ATTRIBUTE_COMPRESSED
0x800 |
To set a file's compression state, use the DeviceIoControl function with the FSCTL_SET_COMPRESSIONoperation. |
| FILE_ATTRIBUTE_DEVICE
0x40 |
Reserved; do not use. |
| FILE_ATTRIBUTE_DIRECTORY
0x10 |
Files cannot be converted into directories. To create a directory, use the CreateDirectory orCreateDirectoryEx function. |
| FILE_ATTRIBUTE_ENCRYPTED
0x4000 |
To create an encrypted file, use the CreateFile function with the FILE_ATTRIBUTE_ENCRYPTED attribute. To convert an existing file into an encrypted file, use the EncryptFile function. |
| FILE_ATTRIBUTE_REPARSE_POINT
0x400 |
To associate a reparse point with a file or directory, use the DeviceIoControl function with theFSCTL_SET_REPARSE_POINT operation. |
| FILE_ATTRIBUTE_SPARSE_FILE
0x200 |
To set a file's sparse attribute, use the DeviceIoControl function with the FSCTL_SET_SPARSE operation. |
Transacted Operations
If a file is open for modification in a transaction, no other thread can open the file for modification until the transaction is committed. So if a transacted thread opens the file first, any subsequent threads that try modifying the file before the transaction is committed receives a sharing violation. If a non-transacted thread modifies the file before the transacted thread does, and the file is still open when the transaction attempts to open it, the transaction receives the error ERROR_TRANSACTIONAL_CONFLICT.