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