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.\" $DragonFly: src/share/man/man9/VOP_READLINK.9,v 1.4 2004/06/01 11:36:53 hmp Exp $ 29.\" 30.Dd July 24, 1996 31.Os 32.Dt VOP_READLINK 9 33.Sh NAME 34.Nm VOP_READLINK 35.Nd read the target of a symbolic link 36.Sh SYNOPSIS 37.In sys/param.h 38.In sys/vnode.h 39.In sys/uio.h 40.Ft int 41.Fn VOP_READLINK "struct vnode *vp" "struct uio *uio" "struct ucred *cred" 42.Sh DESCRIPTION 43This reads the target pathname of a symbolic link 44.Bl -tag -width uio 45.It Fa vp 46the vnode of the symlink 47.It Fa uio 48the location of the data to be read or written 49.It Fa cred 50the credentials of the caller 51.El 52.Sh LOCKS 53The vnode should be locked on entry and will still be locked on exit. 54.Sh RETURN VALUES 55Zero is returned on success, otherwise an error code is returned. 56.Sh PSEUDOCODE 57.Bd -literal 58int 59vop_readlink(struct vnode *vp, struct uio *uio, struct ucred *cred) 60{ 61 int error = 0; 62 63 /* 64 * Read the target of the symlink. 65 */ 66 ...; 67 68 return error; 69} 70.Ed 71.Sh ERRORS 72.Bl -tag -width Er 73.It Bq Er EIO 74a read error occurred while reading the contents of the symlink 75.El 76.Sh SEE ALSO 77.Xr uiomove 9 , 78.Xr vnode 9 79.Sh AUTHORS 80This man page was written by 81.An Doug Rabson . 82