man.bsd.lv manual page server

Manual Page Search Parameters
GETFH(2) System Calls Manual GETFH(2)

getfh, lgetfh — get file handle

library “libc”

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

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

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

The () system call returns a file handle for the specified file or directory in the file handle pointed to by fhp. The () system call is like getfh() except in the case where the named file is a symbolic link, in which case lgetfh() returns information about the link, while getfh() returns information about the file the link references. These system calls are 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.

The getfh() and lgetfh() system calls fail if one or more of the following are true:

[]
A component of the path prefix of path is not a directory.
[]
The length of a component of path exceeds 255 characters, or the length of path exceeds 1023 characters.
[]
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 fhp argument points to an invalid address.
[]
An I/O error occurred while reading from or writing to the file system.

fhopen(2), open(2), stat(2)

The getfh() system call first appeared in 4.4BSD.

April 14, 2011 FreeBSD-12.0