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.

realPath

Obtains the canonicalized absolute path name corresponding to an open file handle.

This function has limited platform support, and using it can lead to unnecessary failures and race conditions. It is generally advisable to avoid this function entirely.

File.realPath

pub fn realPath(file: File, io: Io, out_buffer: []u8) RealPathError!usize

File

lib/std/Io/File.zig:709

Code

pub fn realPath(file: File, io: Io, out_buffer: []u8) RealPathError!usize {
    return io.vtable.fileRealPath(io.userdata, file, out_buffer);
}