share/man/man9/VOP_READLINK.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VOP_READLINK.9,v 1.7.2.2 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd July 24, 1996
  30 .Dt VOP_READLINK 9
  31 .Os
  32 .Sh NAME
  33 .Nm VOP_READLINK
  34 .Nd read the target of a symbolic link
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/vnode.h
  38 .In sys/uio.h
  39 .Ft int
  40 .Fn VOP_READLINK "struct vnode *vp" "struct uio *uio" "struct ucred *cred"
  41 .Sh DESCRIPTION
  42 This reads the target pathname of a symbolic link
  43 .Bl -tag -width uio
  44 .It Fa vp
  45 the vnode of the symlink
  46 .It Fa uio
  47 the location of the data to be read or written
  48 .It Fa cred
  49 the credentials of the caller
  50 .El
  51 .Sh LOCKS
  52 The vnode should be locked on entry and will still be locked on exit.
  53 .Sh RETURN VALUES
  54 Zero is returned on success, otherwise an error code is returned.
  55 .Sh PSEUDOCODE
  56 .Bd -literal
  57 int
  58 vop_readlink(struct vnode *vp, struct uio *uio, struct ucred *cred)
  59 {
  60     int error = 0;
  61
  62     /*
  63      * Read the target of the symlink.
  64      */
  65     ...;
  66
  67     return error;
  68 }
  69 .Ed
  70 .Sh ERRORS
  71 .Bl -tag -width Er
  72 .It Bq Er EIO
  73 a read error occurred while reading the contents of the symlink
  74 .El
  75 .Sh SEE ALSO
  76 .Xr uiomove 9 ,
  77 .Xr vnode 9
  78 .Sh AUTHORS
  79 This man page was written by
  80 .An Doug Rabson .