This function sets the attributes of a file. A remote application interface (RAPI) version of this function exists, and it is called CeSetFileAttributes.
At a Glance
| Header file: | Winbase.h |
| Windows CE versions: | 1.0 and later |
Syntax
BOOL SetFileAttributes(LPCTSTR lpFileName, DWORD dwFileAttributes);
Parameters
lpFileName
[in] Pointer to a string that specifies the name of the file whose attributes are to be set.
There is a default string size limit for paths of MAX_PATH characters. This limit is related to how the SetFileAttributes function parses paths.
dwFileAttributes
[in] Specifies the file attributes to set for the file. This parameter can be a combination of the following values. However, all other values override FILE_ATTRIBUTE_NORMAL.
| Value | Description |
| FILE_ATTRIBUTE_ARCHIVE | The file is an archive file. Applications use this attribute to mark files for backup or removal. |
| FILE_ATTRIBUTE_HIDDEN | The file is hidden. It is not included in an ordinary directory listing. |
| FILE_ATTRIBUTE_NORMAL | The file has no other attributes set. This attribute is valid only if used alone. |
| FILE_ATTRIBUTE_READONLY | The file is read-only. Applications can read the file but cannot write to it or delete it. |
| FILE_ATTRIBUTE_SYSTEM | The file is part of the operating system or is used exclusively by it. |
| FILE_ATTRIBUTE_TEMPORARY | The file is being used for temporary storage. File systems attempt to keep all of the data in memory for quicker access rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed. |
Return Values
Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.
Remarks
The SetFileAttributes function does work on the RAM file system. Inherently, this call is dependent on the file system support provided by a file system driver.
The following table describes how to set the attributes that cannot be set using SetFileAttributes.
| Attribute | How to Set |
| FILE_ATTRIBUTE_COMPRESSED | To set a file's compression state, use the DeviceIoControl function with the FSCTL_SET_COMPRESSION operation. |
| FILE_ATTRIBUTE_DIRECTORY | Files cannot be converted into directories. To create a directory, use the CreateDirectory function. |
| FILE_ATTRIBUTE_REPARSE_POINT | To associate a reparse point with a file, use the DeviceIoControl function with the FSCTL_SET_REPARSE_POINT operation. |
| FILE_ATTRIBUTE_SPARSE_FILE | To set a file's sparse attribute, use the DeviceIoControl function with the FSCTL_SET_SPARSE operation. |
| FILE_ATTRIBUTE_SYSTEM | This attribute cannot be set. |
Not all file systems support all attributes.
See Also