getfh(2)

getfh2

Get file handle

Usage

#include <sys/types.h>

#include <sys/mount.h>

int

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

Overview

getfh() returns a file handle for the specified file or directory in the file handle pointed to by fhp. This system call is restricted to the super-user and is used by an NFS server's nfsd(8) daemon to obtain file handles used in NFS MOUNT service replies.

Return values

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

Errors

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

[ENOTDIR]

A component of the path prefix of path is not a directory.

[ENAMETOOLONG]

The length of a component of path exceeds {NAME_MAX} characters, or the length of path exceeds {PATH_MAX} characters.

[ENOENT]

The file referred to by path does not exist.

[EPERM]

The caller is not the super-user.

[EACCES]

Search permission is denied for a component of the path prefix of path.

[ELOOP]

Too many symbolic links were encountered in translating path.

[EFAULT]

Fhp points to an invalid address.

[EIO]

An I/O error occurred while reading from or writing to the file system.

Releases

155 releases since Mac OS X 10.0; the text changed 2 times.

  1. 10.0–10.4.11
  2. 10.5–10.11.6
  3. 10.12–26.5

History

The getfh() function first appeared in 4.4BSD.

From xnu 12377.121.6 in macOS 26.5. Parsed by carta from the page's mdoc source.