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 Function

checkEvent

Public Function
std.os.uefi.tables.boot_services.BootServices.checkEvent
pub fn checkEvent(self: *BootServices, event: Event) CheckEventError!bool

Checks to see whether an event is signaled.

The underlying function is equivalent to this pseudo-code:

if (event.type.signal)
    return error.InvalidParameter;

if (event.signaled) {
    event.signaled = false;
    return true;
}

const notify = event.notification_function orelse return false;
notify();

if (event.signaled) {
    event.signaled = false;
    return true;
}

return false;

Params

File

os/uefi/tables/boot_services.zig:571
571
572
573
574
575
576
577
578
    pub fn checkEvent(self: *BootServices, event: Event) CheckEventError!bool {
        switch (self._checkEvent(event)) {
            .success => return true,
            .not_ready => return false,
            .invalid_parameter => return error.InvalidParameter,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }