Skip to content

std.os.uefi.protocol.hii_popup

Standard libraryZig 0.17.1Official documentation
Sourcestd/os/uefi/protocol/hii_popup.zig

Source line 1

std.os.uefi.protocol.hii_popup.cc

alias

Source line 6

Alias of std.os.uefi.cc

std.os.uefi.protocol.hii_popup.Guid

alias

Source line 3

Alias of std.os.uefi.Guid

std.os.uefi.protocol.hii_popup.hii

alias

Source line 5

Alias of std.os.uefi.hii

std.os.uefi.protocol.hii_popup.HiiPopup

container

Source line 9

Display a popup window

Fields

revision: u64
_create_popup: *const fn (*const HiiPopup, PopupStyle, PopupType, hii.Handle, u16, ?*PopupSelection) callconv(cc) Status

std.os.uefi.protocol.hii_popup.HiiPopup.createPopup

function

Source line 19

Displays a popup window.

pub fn createPopup( self: *const HiiPopup, style: PopupStyle, popup_type: PopupType, handle: hii.Handle, msg: u16, ) CreatePopupError!PopupSelection

Parameters

self: *const HiiPopup
style: PopupStyle
popup_type: PopupType
handle: hii.Handle
msg: u16

Errors

InvalidParameter
OutOfResources
Unexpected UnexpectedError

std.os.uefi.protocol.hii_popup.HiiPopup.CreatePopupError

error-set

Source line 13

Errors

InvalidParameter
OutOfResources
Unexpected UnexpectedError

std.os.uefi.protocol.hii_popup.HiiPopup.guid

constant

Source line 35

std.os.uefi.protocol.hii_popup.HiiPopup.PopupSelection

container

Source line 57

Fields

ok
cancel
yes
no

std.os.uefi.protocol.hii_popup.HiiPopup.PopupStyle

container

Source line 44

Fields

info
warning
@"error"

std.os.uefi.protocol.hii_popup.HiiPopup.PopupType

container

Source line 50

Fields

ok
cancel
yes_no
yes_no_cancel

std.os.uefi.protocol.hii_popup.Status

alias

Source line 4

Alias of std.os.uefi.Status

std.os.uefi.protocol.hii_popup.std

alias

Source line 1

Alias of std

std.os.uefi.protocol.hii_popup.uefi

alias

Source line 2

Alias of std.os.uefi

Source code

std/os/uefi/protocol/hii_popup.zig

const std = @import("std");
const uefi = std.os.uefi;
const Guid = uefi.Guid;
const Status = uefi.Status;
const hii = uefi.hii;
const cc = uefi.cc;

/// Display a popup window
pub const HiiPopup = extern struct {
    revision: u64,
    _create_popup: *const fn (*const HiiPopup, PopupStyle, PopupType, hii.Handle, u16, ?*PopupSelection) callconv(cc) Status,

    pub const CreatePopupError = uefi.UnexpectedError || error{
        InvalidParameter,
        OutOfResources,
    };

    /// Displays a popup window.
    pub fn createPopup(
        self: *const HiiPopup,
        style: PopupStyle,
        popup_type: PopupType,
        handle: hii.Handle,
        msg: u16,
    ) CreatePopupError!PopupSelection {
        var res: PopupSelection = undefined;
        switch (self._create_popup(self, style, popup_type, handle, msg, &res)) {
            .success => return res,
            .invalid_parameter => return error.InvalidParameter,
            .out_of_resources => return error.OutOfResources,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub const guid align(8) = Guid{
        .time_low = 0x4311edc0,
        .time_mid = 0x6054,
        .time_high_and_version = 0x46d4,
        .clock_seq_high_and_reserved = 0x9e,
        .clock_seq_low = 0x40,
        .node = [_]u8{ 0x89, 0x3e, 0xa9, 0x52, 0xfc, 0xcc },
    };

    pub const PopupStyle = enum(u32) {
        info,
        warning,
        @"error",
    };

    pub const PopupType = enum(u32) {
        ok,
        cancel,
        yes_no,
        yes_no_cancel,
    };

    pub const PopupSelection = enum(u32) {
        ok,
        cancel,
        yes,
        no,
    };
};