lib/libc/sys/getfh.2

   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 .\" 4. 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$
  30 .\"
  31 .Dd April 14, 2011
  32 .Dt GETFH 2
  33 .Os
  34 .Sh NAME
  35 .Nm getfh ,
  36 .Nm lgetfh
  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 .Ft int
  46 .Fn lgetfh "const char *path" "fhandle_t *fhp"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn getfh
  50 system call
  51 returns a file handle for the specified file or directory
  52 in the file handle pointed to by
  53 .Fa fhp .
  54 The
  55 .Fn lgetfh
  56 system call is like
  57 .Fn getfh
  58 except in the case where the named file is a symbolic link,
  59 in which case
  60 .Fn lgetfh
  61 returns information about the link,
  62 while
  63 .Fn getfh
  64 returns information about the file the link references.
  65 These system calls are restricted to the superuser.
  66 .Sh RETURN VALUES
  67 .Rv -std
  68 .Sh ERRORS
  69 The
  70 .Fn getfh
  71 and
  72 .Fn lgetfh
  73 system calls
  74 fail if one or more of the following are true:
  75 .Bl -tag -width Er
  76 .It Bq Er ENOTDIR
  77 A component of the path prefix of
  78 .Fa path
  79 is not a directory.
  80 .It Bq Er ENAMETOOLONG
  81 The length of a component of
  82 .Fa path
  83 exceeds 255 characters,
  84 or the length of
  85 .Fa path
  86 exceeds 1023 characters.
  87 .It Bq Er ENOENT
  88 The file referred to by
  89 .Fa path
  90 does not exist.
  91 .It Bq Er EACCES
  92 Search permission is denied for a component of the path prefix of
  93 .Fa path .
  94 .It Bq Er ELOOP
  95 Too many symbolic links were encountered in translating
  96 .Fa path .
  97 .It Bq Er EFAULT
  98 The
  99 .Fa fhp
 100 argument
 101 points to an invalid address.
 102 .It Bq Er EIO
 103 An
 104 .Tn I/O
 105 error occurred while reading from or writing to the file system.
 106 .El
 107 .Sh SEE ALSO
 108 .Xr fhopen 2 ,
 109 .Xr open 2 ,
 110 .Xr stat 2
 111 .Sh HISTORY
 112 The
 113 .Fn getfh
 114 system call first appeared in
 115 .Bx 4.4 .