1.\" Copyright (c) 1989, 1991 The Regents of the University of California. 2.\" 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. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" from: @(#)getfh.2 6.4 (Berkeley) 7/23/91 33.\" $Id: getfh.2,v 1.5 1994/04/22 00:13:35 jtc Exp $ 34.\" 35.Dd July 23, 1991 36.Dt GETFH 2 37.Os 38.Sh NAME 39.Nm getfh 40.Nd get file handle 41.Sh SYNOPSIS 42.Fd #include <sys/types.h> 43.Fd #include <sys/mount.h> 44.Ft int 45.Fn getfh "char *path" "struct fhandle_t *fhp" 46.Sh DESCRIPTION 47.Fn Getfh 48returns a file handle for the specified file or directory 49in the file handle pointed to by 50.Fa fhp . 51This system call is restricted to the superuser. 52.Sh RETURN VALUES 53Upon successful completion, a value of 0 is returned. 54Otherwise, -1 is returned and the global variable 55.Va errno 56is set to indicate the error. 57.Sh ERRORS 58.Fn Getfh 59fails if one or more of the following are true: 60.Bl -tag -width Er 61.It Bq ENOTDIR 62A component of the path prefix of 63.Fa path 64is not a directory. 65.It Bq ENAMETOOLONG 66The length of a component of 67.Fa path 68exceeds 69.Dv {NAME_MAX} 70characters, or the length of 71.Fa path 72exceeds 73.Dv {PATH_MAX} 74characters. 75.It Bq ENOENT 76The file referred to by 77.Fa path 78does not exist. 79.It Bq EACCES 80Search permission is denied for a component of the path prefix of 81.Fa path . 82.It Bq ELOOP 83Too many symbolic links were encountered in translating 84.Fa path . 85.It Bq EFAULT 86.Fa Fhp 87points to an invalid address. 88.It Bq EIO 89An 90.Tn I/O 91error occurred while reading from or writing to the file system. 92.El 93.Sh HISTORY 94The 95.Fn getfh 96function call is 97.Ud . 98