Function unlinkW [src]

Windows-only. Same as unlink except the parameter is null-terminated, WTF16 LE encoded.

Prototype

pub fn unlinkW(file_path_w: []const u16) UnlinkError!void

Parameters

file_path_w: []const u16

Possible Errors

AccessDenied

In WASI, this error may occur when the file descriptor does not hold the required rights to unlink a resource by path relative to it.

BadPathName

On Windows, file paths cannot contain these characters: '/', '*', '?', '"', '<', '>', '|'

FileBusy

FileNotFound

FileSystem

InvalidUtf8

WASI-only; file paths must be valid UTF-8.

InvalidWtf8

Windows-only; file paths provided by the user must be valid WTF-8. https://simonsapin.github.io/wtf-8/

IsDir

NameTooLong

NetworkNotFound

On Windows, \\server or \\server\share was not found.

NotDir

PermissionDenied

ReadOnlyFileSystem

SymLinkLoop

SystemResources

Unexpected UnexpectedError

The Operating System returned an undocumented error code.

This error is in theory not possible, but it would be better to handle this error than to invoke undefined behavior.

When this error code is observed, it usually means the Zig Standard Library needs a small patch to add the error code to the error set for the respective function.

Source

  pub fn unlinkW(file_path_w: []const u16) UnlinkError!void {
    windows.DeleteFile(file_path_w, .{ .dir = fs.cwd().fd }) catch |err| switch (err) {
        error.DirNotEmpty => unreachable, // we're not passing .remove_dir = true
        else => |e| return e,
    };
}  