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

Flags

Public Struct
std.coff.Header.Flags
pub const Flags = packed struct(u16)

Fields

RELOCS_STRIPPED: bool = false

Image only, Windows CE, and Microsoft Windows NT and later. This indicates that the file does not contain base relocations and must therefore be loaded at its preferred base address. If the base address is not available, the loader reports an error. The default behavior of the linker is to strip base relocations from executable (EXE) files.

EXECUTABLE_IMAGE: bool = false

Image only. This indicates that the image file is valid and can be run. If this flag is not set, it indicates a linker error.

LINE_NUMS_STRIPPED: bool = false

COFF line numbers have been removed. This flag is deprecated and should be zero.

LOCAL_SYMS_STRIPPED: bool = false

COFF symbol table entries for local symbols have been removed. This flag is deprecated and should be zero.

AGGRESSIVE_WS_TRIM: bool = false

Obsolete. Aggressively trim working set. This flag is deprecated for Windows 2000 and later and must be zero.

LARGE_ADDRESS_AWARE: bool = false

Application can handle > 2-GB addresses.

RESERVED: bool = false

This flag is reserved for future use.

BYTES_REVERSED_LO: bool = false

Little endian: the least significant bit (LSB) precedes the most significant bit (MSB) in memory. This flag is deprecated and should be zero.

@"32BIT_MACHINE": bool = false

Machine is based on a 32-bit-word architecture.

DEBUG_STRIPPED: bool = false

Debugging information is removed from the image file.

REMOVABLE_RUN_FROM_SWAP: bool = false

If the image is on removable media, fully load it and copy it to the swap file.

NET_RUN_FROM_SWAP: bool = false

If the image is on network media, fully load it and copy it to the swap file.

SYSTEM: bool = false

The image file is a system file, not a user program.

DLL: bool = false

The image file is a dynamic-link library (DLL). Such files are considered executable files for almost all purposes, although they cannot be directly run.

UP_SYSTEM_ONLY: bool = false

The file should be run only on a uniprocessor machine.

BYTES_REVERSED_HI: bool = false

Big endian: the MSB precedes the LSB in memory. This flag is deprecated and should be zero.

File

coff.zig:38
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
    pub const Flags = packed struct(u16) {
        /// Image only, Windows CE, and Microsoft Windows NT and later.
        /// This indicates that the file does not contain base relocations
        /// and must therefore be loaded at its preferred base address.
        /// If the base address is not available, the loader reports an error.
        /// The default behavior of the linker is to strip base relocations
        /// from executable (EXE) files.
        RELOCS_STRIPPED: bool = false,

        /// Image only. This indicates that the image file is valid and can be run.
        /// If this flag is not set, it indicates a linker error.
        EXECUTABLE_IMAGE: bool = false,

        /// COFF line numbers have been removed. This flag is deprecated and should be zero.
        LINE_NUMS_STRIPPED: bool = false,

        /// COFF symbol table entries for local symbols have been removed.
        /// This flag is deprecated and should be zero.
        LOCAL_SYMS_STRIPPED: bool = false,

        /// Obsolete. Aggressively trim working set.
        /// This flag is deprecated for Windows 2000 and later and must be zero.
        AGGRESSIVE_WS_TRIM: bool = false,

        /// Application can handle > 2-GB addresses.
        LARGE_ADDRESS_AWARE: bool = false,

        /// This flag is reserved for future use.
        RESERVED: bool = false,

        /// Little endian: the least significant bit (LSB) precedes the
        /// most significant bit (MSB) in memory. This flag is deprecated and should be zero.
        BYTES_REVERSED_LO: bool = false,

        /// Machine is based on a 32-bit-word architecture.
        @"32BIT_MACHINE": bool = false,

        /// Debugging information is removed from the image file.
        DEBUG_STRIPPED: bool = false,

        /// If the image is on removable media, fully load it and copy it to the swap file.
        REMOVABLE_RUN_FROM_SWAP: bool = false,

        /// If the image is on network media, fully load it and copy it to the swap file.
        NET_RUN_FROM_SWAP: bool = false,

        /// The image file is a system file, not a user program.
        SYSTEM: bool = false,

        /// The image file is a dynamic-link library (DLL).
        /// Such files are considered executable files for almost all purposes,
        /// although they cannot be directly run.
        DLL: bool = false,

        /// The file should be run only on a uniprocessor machine.
        UP_SYSTEM_ONLY: bool = false,

        /// Big endian: the MSB precedes the LSB in memory. This flag is deprecated and should be zero.
        BYTES_REVERSED_HI: bool = false,
    }