file_attribute.h File Reference

#include <cstdint>

Definition

Contains console file attribute constants.

Copyright

Copyright (c) 2024 Gammasoft. All rights reserved.

Go to the source code of this file.

Variables
constexpr int32_t	FILE_ATTRIBUTE_READONLY
	The file is read-only.
constexpr int32_t	FILE_ATTRIBUTE_HIDDEN
	The file is hidden, and thus is not included in an ordinary directory listing.
constexpr int32_t	FILE_ATTRIBUTE_SYSTEM
	The file is a system file. The file is part of the operating system or is used exclusively by the operating system.
constexpr int32_t	FILE_ATTRIBUTE_DIRECTORY
	The file is a directory.
constexpr int32_t	FILE_ATTRIBUTE_ARCHIVE
	The file's archive status. Applications use this attribute to mark files for backup or removal.
constexpr int32_t	FILE_ATTRIBUTE_DEVICE
	Reserved for future use.
constexpr int32_t	FILE_ATTRIBUTE_NORMAL
	The file is normal and has no other attributes set. This attribute is valid only if used alone.
constexpr int32_t	FILE_ATTRIBUTE_TEMPORARY
	The file is temporary. 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.
constexpr int32_t	FILE_ATTRIBUTE_SPARSE_FILE
	The file is a sparse file. Sparse files are typically large files whose data are mostly zeros.
constexpr int32_t	FILE_ATTRIBUTE_REPARSE_POINT
	The file contains a reparse point, which is a block of user-defined data associated with a file or a directory.
constexpr int32_t	FILE_ATTRIBUTE_COMPRESSED
	The file is compressed.
constexpr int32_t	FILE_ATTRIBUTE_OFFLINE
	The file is offline. The data of the file is not immediately available.
constexpr int32_t	FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
	The file will not be indexed by the operating system's content indexing service.
constexpr int32_t	FILE_ATTRIBUTE_ENCRYPTED
	The file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and directories.
constexpr int32_t	FILE_ATTRIBUTE_INTEGRITY_STREAM
	The directory or user data stream is configured with integrity (only supported on ReFS volumes). It is not included in an ordinary directory listing. The integrity setting persists with the file if it's renamed. If a file is copied the destination file will have integrity set if either the source file or destination directory have integrity set.
constexpr int32_t	FILE_ATTRIBUTE_VIRTUAL
	This value is reserved for system use.
constexpr int32_t	FILE_ATTRIBUTE_NO_SCRUB_DATA
	The user data stream not to be read by the background data integrity scanner (AKA scrubber). When set on a directory it only provides inheritance. This flag is only supported on Storage Spaces and ReFS volumes. It is not included in an ordinary directory listing.
constexpr int32_t	FILE_ATTRIBUTE_EA
	(Not documented).
constexpr int32_t	FILE_ATTRIBUTE_PINNED
	(Not documented).
constexpr int32_t	FILE_ATTRIBUTE_UNPINNED
	(Not documented).
constexpr int32_t	FILE_ATTRIBUTE_RECALL_ON_OPEN
	This attribute only appears in directory enumeration classes (FILE_DIRECTORY_INFORMATION, FILE_BOTH_DIR_INFORMATION, etc.). When this attribute is set, it means that the file or directory has no physical representation on the local system; the item is virtual. Opening the item will be more expensive than normal, e.g. it will cause at least some of it to be fetched from a remote store.
constexpr int32_t	FILE_ATTRIBUTE_RECALL_ON_DATA_ACCESS
	When this attribute is set, it means that the file or directory is not fully present locally. For a file that means that not all of its data is on local storage (e.g. it may be sparse with some data still in remote storage). For a directory it means that some of the directory contents are being virtualized from another location. Reading the file / enumerating the directory will be more expensive than normal, e.g. it will cause at least some of the file/directory content to be fetched from a remote store. Only kernel-mode callers can set this bit.