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.\" $Id: VOP_READLINK.9,v 1.2 1997/03/04 10:02:31 dfr Exp $ 30.\" 31.Dd July 24, 1996 32.Os 33.Dt VOP_READLINK 9 34.Sh NAME 35.Nm VOP_READLINK 36.Nd read the target of a symbolic link 37.Sh SYNOPSIS 38.Fd #include <sys/vnode.h> 39.Fd #include <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 Ar vp 46the vnode of the symlink 47.It Ar uio 48the location of the data to be read or written 49.It Ar cnp 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 vnode 9 , 78.Xr uiomove 9 79.Sh AUTHORS 80This man page was written by Doug Rabson. 81