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

delete

Public Function
std.os.uefi.protocol.file.File.delete
pub fn delete(self: *File) uefi.UnexpectedError!bool

Delete the file.

Returns true if the file was deleted, false if the file was not deleted, which is a warning according to the UEFI specification.

Params

File

os/uefi/protocol/file.zig:120
120
121
122
123
124
125
126
    pub fn delete(self: *File) uefi.UnexpectedError!bool {
        switch (self._delete(self)) {
            .success => return true,
            .warn_delete_failure => return false,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }