CeGetFileAttributes (RAPI) (Windows CE 5.0)
This function returns attributes for a specified file or directory.
CeGetFileAttributes is a remote application programming interface (RAPI), which enables an application running on a desktop computer to make function calls on a Windows CE–based device.
DWORDCeGetFileAttributes(LPCWSTRlpFileName);
Parameters
lpFileName
[in] Long pointer to a null-terminated string that specifies the name of a file or directory.There is a default string size limit for paths of MAX_PATH characters. This limit is related to how the CeGetFileAttributes function parses paths. An application can transcend this limit and send in paths longer than MAX_PATH characters by prepending \\?\ to the path. The \\?\ tells the function to turn off path parsing; it lets paths longer than MAX_PATH be used with CeGetFileAttributes. However, each component in the path cannot be more than MAX_PATH characters long. This also works with Universal Naming Convention (UNC) names. The \\?\ is ignored as part of the path. For example, \\?\C:\myworld\private is seen as C:\myworld\private.
Return Values
The attributes of the specified file or directory, returned in a DWORD, indicates success. 0xFFFFFFFF indicates failure. To determine if a function failed because of RAPI errors, call CeRapiGetError. To determine if a function failed because of non-RAPI errors, call CeGetLastError.
The attributes returned upon success can be one or more of the following values.
| Value | Description |
|---|---|
| FILE_ATTRIBUTE_ARCHIVE | The file or directory is an archive file or directory. Applications use this attribute to mark files for backup or removal. |
| FILE_ATTRIBUTE_COMPRESSED | The file or directory is compressed. For a file, this means that all of the data in the file is compressed. For a directory, this means that compression is the default for newly created files and subdirectories. |
| FILE_ATTRIBUTE_DIRECTORY | The handle identifies a directory. |
| FILE_ATTRIBUTE_ENCRYPTED | The file or directory is encrypted. For a file, this means that all data streams are encrypted. For a directory, this means that encryption is the default for newly created files and subdirectories. |
| FILE_ATTRIBUTE_HIDDEN | The file or directory is hidden. It is not included in an ordinary directory listing. |
| FILE_ATTRIBUTE_INROM | This file is an operating system file stored in ROM. These files are read-only; they cannot be modified. |
| FILE_ATTRIBUTE_NORMAL | The file or directory has no other attributes set. This attribute is valid only if used alone. |
| FILE_ATTRIBUTE_READONLY | The file or directory is read-only. Applications can read the file but cannot write to it or delete it. In the case of a directory, applications cannot delete it. |
| FILE_ATTRIBUTE_REPARSE_POINT | The file has an associated reparse point. |
| FILE_ATTRIBUTE_ROMMODULE | This file is an operating system file stored in ROM and executed directly from ROM, rather than being first copied to RAM. The CreateFile function cannot be used to access this file, instead the LoadLibrary and CreateProcess functions must be used. |
| FILE_ATTRIBUTE_SPARSE_FILE | The file is a sparse file. |
| FILE_ATTRIBUTE_SYSTEM | The file or directory is part of, or is used exclusively by, the operating system. |
| 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. |
Remarks
When writing applications for Windows CE 1.0 and 1.01, use the PegGetFileAttributes function.
Requirements
OS Versions: Windows CE 2.0 and later.
Header: Rapi.h.
Link Library: Rapi.lib.
See Also
RAPI Functions | CeGetLastError | CeRapiGetError | CreateFile | CreateProcess | GetFileAttributes | LoadLibrary
Send Feedback on this topic to the authors