OpenBSD manual page server

Manual Page Search Parameters

GETFH(2) System Calls Manual GETFH(2)

getfhget file handle

#include <sys/types.h>
#include <sys/mount.h>

int
getfh(const char *path, fhandle_t *fhp);

() returns a file handle for the specified file or directory path in the file handle pointed to by fhp. This system call is restricted to the superuser.

Upon successful completion, the value 0 is returned; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

getfh() fails if one or more of the following are true:

[]
A component of the path prefix of path is not a directory.
[]
A component of a pathname exceeded NAME_MAX characters, or an entire pathname (including the terminating NUL) exceeded PATH_MAX bytes.
[]
The file referred to by path does not exist.
[]
Search permission is denied for a component of the path prefix of path.
[]
Too many symbolic links were encountered in translating path.
[]
The effective user ID is not the superuser.
[]
fhp or path points to an invalid address.
[]
An I/O error occurred while reading from or writing to the file system.
[]
A portion of path refers to a remote file system.
[]
A portion of path refers to a remote file system.

fhstat(2)

The getfh() function first appeared in 4.3BSD-Reno.

July 30, 2022 OpenBSD-current