1.\" Copyright (c) 1989, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)getfh.2 8.1 (Berkeley) 6/9/93 29.\" $FreeBSD: src/lib/libc/sys/getfh.2,v 1.7.2.4 2001/12/14 18:34:00 ru Exp $ 30.\" $DragonFly: src/lib/libc/sys/getfh.2,v 1.2 2003/06/17 04:26:47 dillon Exp $ 31.\" 32.Dd June 9, 1993 33.Dt GETFH 2 34.Os 35.Sh NAME 36.Nm getfh 37.Nd get file handle 38.Sh LIBRARY 39.Lb libc 40.Sh SYNOPSIS 41.In sys/param.h 42.In sys/mount.h 43.Ft int 44.Fn getfh "const char *path" "fhandle_t *fhp" 45.Sh DESCRIPTION 46.Fn Getfh 47returns a file handle for the specified file or directory 48in the file handle pointed to by 49.Fa fhp . 50This system call is restricted to the superuser. 51.Sh RETURN VALUES 52.Rv -std getfh 53.Sh ERRORS 54.Fn Getfh 55fails if one or more of the following are true: 56.Bl -tag -width Er 57.It Bq Er ENOTDIR 58A component of the path prefix of 59.Fa path 60is not a directory. 61.It Bq Er ENAMETOOLONG 62The length of a component of 63.Fa path 64exceeds 255 characters, 65or the length of 66.Fa path 67exceeds 1023 characters. 68.It Bq Er ENOENT 69The file referred to by 70.Fa path 71does not exist. 72.It Bq Er EACCES 73Search permission is denied for a component of the path prefix of 74.Fa path . 75.It Bq Er ELOOP 76Too many symbolic links were encountered in translating 77.Fa path . 78.It Bq Er EFAULT 79.Fa Fhp 80points to an invalid address. 81.It Bq Er EIO 82An 83.Tn I/O 84error occurred while reading from or writing to the file system. 85.El 86.Sh HISTORY 87The 88.Fn getfh 89function 90first appeared in 91.Bx 4.4 . 92