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 .\" 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 .\"     @(#)getfh.2     8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/lib/libc/sys/getfh.2,v 1.7.2.4 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/getfh.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  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 .In sys/param.h
  46 .In sys/mount.h
  47 .Ft int
  48 .Fn getfh "const char *path" "fhandle_t *fhp"
  49 .Sh DESCRIPTION
  50 .Fn Getfh
  51 returns a file handle for the specified file or directory
  52 in the file handle pointed to by
  53 .Fa fhp .
  54 This system call is restricted to the superuser.
  55 .Sh RETURN VALUES
  56 .Rv -std getfh
  57 .Sh ERRORS
  58 .Fn Getfh
  59 fails if one or more of the following are true:
  60 .Bl -tag -width Er
  61 .It Bq Er ENOTDIR
  62 A component of the path prefix of
  63 .Fa path
  64 is not a directory.
  65 .It Bq Er ENAMETOOLONG
  66 The length of a component of
  67 .Fa path
  68 exceeds 255 characters,
  69 or the length of
  70 .Fa path
  71 exceeds 1023 characters.
  72 .It Bq Er ENOENT
  73 The file referred to by
  74 .Fa path
  75 does not exist.
  76 .It Bq Er EACCES
  77 Search permission is denied for a component of the path prefix of
  78 .Fa path .
  79 .It Bq Er ELOOP
  80 Too many symbolic links were encountered in translating
  81 .Fa path .
  82 .It Bq Er EFAULT
  83 .Fa Fhp
  84 points to an invalid address.
  85 .It Bq Er EIO
  86 An
  87 .Tn I/O
  88 error occurred while reading from or writing to the file system.
  89 .El
  90 .Sh HISTORY
  91 The
  92 .Fn getfh
  93 function
  94 first appeared in
  95 .Bx 4.4 .