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 .\"
  35 .Dd June 9, 1993
  36 .Dt GETFH 2
  37 .Os
  38 .Sh NAME
  39 .Nm getfh
  40 .Nd get file handle
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/param.h
  45 .In sys/mount.h
  46 .Ft int
  47 .Fn getfh "const char *path" "fhandle_t *fhp"
  48 .Sh DESCRIPTION
  49 .Fn Getfh
  50 returns a file handle for the specified file or directory
  51 in the file handle pointed to by
  52 .Fa fhp .
  53 This system call is restricted to the superuser.
  54 .Sh RETURN VALUES
  55 .Rv -std getfh
  56 .Sh ERRORS
  57 .Fn Getfh
  58 fails if one or more of the following are true:
  59 .Bl -tag -width Er
  60 .It Bq Er ENOTDIR
  61 A component of the path prefix of
  62 .Fa path
  63 is not a directory.
  64 .It Bq Er ENAMETOOLONG
  65 The length of a component of
  66 .Fa path
  67 exceeds 255 characters,
  68 or the length of
  69 .Fa path
  70 exceeds 1023 characters.
  71 .It Bq Er ENOENT
  72 The file referred to by
  73 .Fa path
  74 does not exist.
  75 .It Bq Er EACCES
  76 Search permission is denied for a component of the path prefix of
  77 .Fa path .
  78 .It Bq Er ELOOP
  79 Too many symbolic links were encountered in translating
  80 .Fa path .
  81 .It Bq Er EFAULT
  82 .Fa Fhp
  83 points to an invalid address.
  84 .It Bq Er EIO
  85 An
  86 .Tn I/O
  87 error occurred while reading from or writing to the file system.
  88 .El
  89 .Sh HISTORY
  90 The
  91 .Fn getfh
  92 function
  93 first appeared in
  94 .Bx 4.4 .