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$
  30 .\"
  31 .Dd July 24, 1996
  32 .Dt VOP_READLINK 9
  33 .Os
  34 .Sh NAME
  35 .Nm VOP_READLINK
  36 .Nd read the target of a symbolic link
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/vnode.h
  40 .In sys/uio.h
  41 .Ft int
  42 .Fn VOP_READLINK "struct vnode *vp" "struct uio *uio" "struct ucred *cred"
  43 .Sh DESCRIPTION
  44 This reads the target pathname of a symbolic link
  45 .Bl -tag -width uio
  46 .It Fa vp
  47 The vnode of the symlink.
  48 .It Fa uio
  49 The location of the data to be read or written.
  50 .It Fa cred
  51 The credentials of the caller.
  52 .El
  53 .Sh LOCKS
  54 The vnode should be locked on entry and will still be locked on exit.
  55 .Sh RETURN VALUES
  56 Zero is returned on success, otherwise an error code is returned.
  57 .Sh ERRORS
  58 .Bl -tag -width Er
  59 .It Bq Er EIO
  60 A read error occurred while reading the contents of the symlink.
  61 .El
  62 .Sh SEE ALSO
  63 .Xr uiomove 9 ,
  64 .Xr vnode 9
  65 .Sh AUTHORS
  66 This manual page was written by
  67 .An Doug Rabson .