This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

This manual page is associated with the Mac OS X developer tools. The software or headers described may not be present on your Mac OS X installation until you install the developer tools package. This package is available on your Mac OS X installation DVD, and the latest versions can be downloaded from developer.apple.com.

For more information about the manual page format, see the manual page for manpages(5).

GETFH(2)                    BSD System Calls Manual                   GETFH(2)

NAME
     getfh -- get file handle

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

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

DESCRIPTION
     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 vari-able variable
     able 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.

SEE ALSO
     nfsd(8)

HISTORY
     The getfh() function first appeared in 4.4BSD.

BSD                             January 9, 2007                            BSD