GetFileAttributes (Windows CE 5.0)
This function returns attributes for a specified file or directory. A RAPI version of this function exists, called CeGetFileAttributes (RAPI).
DWORDGetFileAttributes(LPCTSTRlpFileName );
Parameters
lpFileName
[in] 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 GetFileAttributes function parses paths.
Return Values
The attributes of the specified file or directory, returned in a DWORD, indicates success. 0xFFFFFFFF indicates failure. To get extended error information, call GetLastError.
The attributes returned on success can be one or more of the permitted values. The following table shows the possible return values.
| Value | Description |
|---|---|
| FILE_ATTRIBUTE_ARCHIVE | Indicates that the file or directory is an archive file or directory. Applications use this attribute to mark files for backup or removal. |
| FILE_ATTRIBUTE_COMPRESSED | Indicates that the file or directory is compressed. For a file, this means that all 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 | Indicates that the object is a directory. |
| FILE_ATTRIBUTE_ENCRYPTED | Indicates that 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 | Indicates that the file or directory is hidden. Hidden files and directories are not included in a typical directory listing. |
| FILE_ATTRIBUTE_INROM | Indicates that this file is an OS file stored in ROM. These files are read-only and cannot be modified. |
| FILE_ATTRIBUTE_NORMAL | Indicates that the file has no other attributes set. This attribute is valid only if used alone. |
| FILE_ATTRIBUTE_READONLY | Indicates that 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 or move it. |
| FILE_ATTRIBUTE_ROMMODULE | Indicates that this file is an OS 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_ROMSTATICREF | Indicates that the file is a dynamic-link library (DLL) module that has an implicit reference from at least one other file that is in the modules section of the image. A file having this attribute cannot replace the functionality of the DLL with a RAM copy of the same DLL. A file having this attribute must also have the FILE_ATTRIBUTE_INROM and FILE_ATTRIBUTE_ROMMODULE attributes. |
| FILE_ATTRIBUTE_SYSTEM | Indicates that the file or directory is part of, or is used exclusively by, the OS. |
| FILE_ATTRIBUTE_TEMPORARY | Indicates that the file is being used for temporary storage. File systems attempt to keep 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. |
Requirements
OS Versions: Windows CE 1.0 and later.
Header: Winbase.h.
Link Library: Coredll.lib.
See Also
CreateFile | CreateProcess | CeGetFileAttributes (RAPI) | FindFirstFile | LoadLibrary | SetFileAttributes | GetFileAttributesEx | GetFileInformationByHandle
Send Feedback on this topic to the authors