CeSetFileAttributes (RAPI)
A version of this page is also available for
4/8/2010
This function sets the attributes of a file on a remote Windows Embedded CE–based device.
Syntax
BOOL CeSetFileAttributes(
LPCWSTR lpFileName,
DWORD dwFileAttributes
);
Parameters
lpFileName
[in] Long pointer to a null-terminated 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.
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 Value
Nonzero indicates success. Zero indicates failure. To get extended error information, call CeGetLastError and CeRapiGetError.
Remarks
The CeSetFileAttributes function does not work on the ROM file system. Inherently, this call is dependent on the file system support provided by a file system driver.
An application cannot change the attributes of a directory in the RAM file system.
The following table describes how to set the attributes in the RAM file system that cannot be set using CeSetFileAttributes.
| 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 CeCreateDirectory 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. |
Not all file systems support all attributes.
Requirements
| Header | rapi.h |
| Library | rapi.lib |
| Windows Embedded CE | Windows CE 3.0 and later |
| Windows Mobile | Pocket PC 2002 and later, Smartphone 2002 and later |