xref: /original-bsd/lib/libc/sys/readlink.2 (revision 4b9b56dc)
Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)readlink.2 6.6 (Berkeley) 08/25/89

READLINK 2 ""
C 5
NAME
readlink - read value of a symbolic link
SYNOPSIS
cc = readlink(path, buf, bufsiz)
int cc;
char *path, *buf;
int bufsiz;
DESCRIPTION
Readlink places the contents of the symbolic link name in the buffer buf, which has size bufsiz . The contents of the link are not null terminated when returned.
"RETURN VALUE
The call returns the count of characters placed in the buffer if it succeeds, or a -1 if an error occurs, placing the error code in the global variable errno.
"ERRORS
Readlink will fail if:

15 [ENOTDIR] A component of the path prefix is not a directory.

15 [EINVAL] The pathname contains a character with the high-order bit set.

15 [ENAMETOOLONG] A component of a pathname exceeded 255 characters, or an entire path name exceeded 1023 characters.

15 [ENOENT] The named file does not exist.

15 [EACCES] Search permission is denied for a component of the path prefix.

15 [ELOOP] Too many symbolic links were encountered in translating the pathname.

15 [EINVAL] The named file is not a symbolic link.

15 [EIO] An I/O error occurred while reading from the file system.

15 [EFAULT] Buf extends outside the process's allocated address space.

SEE ALSO
stat(2), lstat(2), symlink(2)