Sets the attributes for a file or directory.
To perform this operation as a transacted operation, use the SetFileAttributesTransacted function.
SyntaxBOOL SetFileAttributesA(
[in] LPCSTR lpFileName,
[in] DWORD dwFileAttributes
);
Parameters
[in] lpFileName
The name of the file whose attributes are to be set.
By default, the name is limited to MAX_PATH characters. To extend this limit to 32,767 wide characters, prepend "\\?\" to the path. For more information, see Naming Files, Paths, and Namespaces.
Tip
Starting with Windows 10, Version 1607, you can opt-in to remove the MAX_PATH limitation without prepending "\\?\". See the "Maximum Path Length Limitation" section of Naming Files, Paths, and Namespaces for details.
[in] 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.
Value MeaningIf the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
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_COMPRESSED0x800
To set a file's compression state, use the DeviceIoControl function with the FSCTL_SET_COMPRESSION operation. FILE_ATTRIBUTE_DEVICE0x40
Reserved; do not use. FILE_ATTRIBUTE_DIRECTORY0x10
Files cannot be converted into directories. To create a directory, use the CreateDirectory or CreateDirectoryEx function. FILE_ATTRIBUTE_ENCRYPTED0x4000
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_POINT0x400
To associate a reparse point with a file or directory, use the DeviceIoControl function with the FSCTL_SET_REPARSE_POINT operation. FILE_ATTRIBUTE_SPARSE_FILE0x200
To set a file's sparse attribute, use the DeviceIoControl function with the FSCTL_SET_SPARSE operation. Transacted OperationsIf 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.
In Windows 8 and Windows Server 2012, this function is supported by the following technologies.
Technology Supported Server Message Block (SMB) 3.0 protocol Yes SMB 3.0 Transparent Failover (TFO) Yes SMB 3.0 with Scale-out File Shares (SO) Yes Cluster Shared Volume File System (CsvFS) Yes Resilient File System (ReFS) Yes ExamplesFor an example, see Retrieving and Changing File Attributes.
Note
The fileapi.h header defines SetFileAttributes as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements Requirement Value Minimum supported client Windows XP [desktop apps | UWP apps] Minimum supported server Windows Server 2003 [desktop apps | UWP apps] Target Platform Windows Header fileapi.h (include Windows.h) Library Kernel32.lib DLL Kernel32.dll See alsoRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4