share/man/man9/VOP_READLINK.9

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