Zig 0.17.0-dev (Split by item)

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 library itself.

executablePath

Get the path to the current executable, following symlinks.

This function may return an error if the current executable was deleted after spawning.

Returned value is a slice of out_buffer.

On Windows, the result is encoded as WTF-8. On other platforms, the result is an opaque sequence of bytes with no particular encoding.

On Linux, depends on procfs being mounted. If the currently executing binary has been deleted, the file path looks something like "/a/b/c/exe (deleted)".

See also:

process.executablePath
pub fn executablePath(io: Io, out_buffer: []u8) ExecutablePathError!usize

File

lib/std/process.zig:767

Code

pub fn executablePath(io: Io, out_buffer: []u8) ExecutablePathError!usize {
    return io.vtable.processExecutablePath(io.userdata, out_buffer);
}