Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Struct

ATTRIBUTE

Public Struct
std.os.windows.FILE.ATTRIBUTE
pub const ATTRIBUTE = packed struct(ULONG)

Fields

READONLY: bool = false

The file is read only. Applications can read the file, but cannot write to or delete it.

HIDDEN: bool = false

The file is hidden. Do not include it in an ordinary directory listing.

SYSTEM: bool = false

The file is part of or used exclusively by an operating system.

Reserved3: u1 = 0
DIRECTORY: bool = false
ARCHIVE: bool = false

The file should be archived. Applications use this attribute to mark files for backup or removal.

DEVICE: bool = false
NORMAL: bool = false

The file does not have other attributes set. This attribute is valid only if used alone.

TEMPORARY: bool = false

The file is being used for temporary storage.

SPARSE_FILE: bool = false
REPARSE_POINT: bool = false
COMPRESSED: bool = false
OFFLINE: bool = false

The data of a file is not immediately available. This attribute indicates that file data is physically moved to offline storage. This attribute is used by Remote Storage, the hierarchical storage management software. Applications should not arbitrarily change this attribute.

NOT_CONTENT_INDEXED: bool = false
ENCRYPTED: bool = false

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 subdirectories. For more information, see File Encryption.

This flag has no effect if SYSTEM is also specified.

This flag is not supported on Home, Home Premium, Starter, or ARM editions of Windows.

INTEGRITY_STREAM: bool = false
VIRTUAL: bool = false
NO_SCRUB_DATA: bool = false
EA_or_RECALL_ON_OPEN: bool = false
PINNED: bool = false
UNPINNED: bool = false
Reserved21: u1 = 0
RECALL_ON_DATA_ACCESS: bool = false
Reserved23: u6 = 0
STRICTLY_SEQUENTIAL: bool = false
Reserved30: u2 = 0

File

os/windows.zig:641
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
    pub const ATTRIBUTE = packed struct(ULONG) {
        /// The file is read only. Applications can read the file, but cannot write to or delete it.
        READONLY: bool = false,
        /// The file is hidden. Do not include it in an ordinary directory listing.
        HIDDEN: bool = false,
        /// The file is part of or used exclusively by an operating system.
        SYSTEM: bool = false,
        Reserved3: u1 = 0,
        DIRECTORY: bool = false,
        /// The file should be archived. Applications use this attribute to mark files for backup or removal.
        ARCHIVE: bool = false,
        DEVICE: bool = false,
        /// The file does not have other attributes set. This attribute is valid only if used alone.
        NORMAL: bool = false,
        /// The file is being used for temporary storage.
        TEMPORARY: bool = false,
        SPARSE_FILE: bool = false,
        REPARSE_POINT: bool = false,
        COMPRESSED: bool = false,
        /// The data of a file is not immediately available. This attribute indicates that file data is physically moved to offline storage.
        /// This attribute is used by Remote Storage, the hierarchical storage management software. Applications should not arbitrarily change this attribute.
        OFFLINE: bool = false,
        NOT_CONTENT_INDEXED: bool = false,
        /// 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 subdirectories. For more information, see File Encryption.
        ///
        /// This flag has no effect if `SYSTEM` is also specified.
        ///
        /// This flag is not supported on Home, Home Premium, Starter, or ARM editions of Windows.
        ENCRYPTED: bool = false,
        INTEGRITY_STREAM: bool = false,
        VIRTUAL: bool = false,
        NO_SCRUB_DATA: bool = false,
        EA_or_RECALL_ON_OPEN: bool = false,
        PINNED: bool = false,
        UNPINNED: bool = false,
        Reserved21: u1 = 0,
        RECALL_ON_DATA_ACCESS: bool = false,
        Reserved23: u6 = 0,
        STRICTLY_SEQUENTIAL: bool = false,
        Reserved30: u2 = 0,
    }