Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

readlink(2) [sunos man page]

readlink(2)							   System Calls 						       readlink(2)

NAME
readlink - read the contents of a symbolic link SYNOPSIS
#include <unistd.h> ssize_t readlink(const char *restrict path, char *restrict buf, size_t bufsiz); DESCRIPTION
The readlink() function places the contents of the symbolic link referred to by path in the buffer buf which has size bufsiz. If the num- ber of bytes in the symbolic link is less than bufsiz, the contents of the remainder of buf are left unchanged. If the buf argument is not large enough to contain the link content, the first bufsize bytes are placed in buf. RETURN VALUES
Upon successful completion, readlink() returns the count of bytes placed in the buffer. Otherwise, it returns -1, leaves the buffer unchanged, and sets errno to indicate the error. ERRORS
The readlink() function will fail if: EACCES Search permission is denied for a component of the path prefix of path. EFAULT path or buf points to an illegal address. EINVAL The path argument names a file that is not a symbolic link. EIO An I/O error occurred while reading from the file system. ENOENT A component of path does not name an existing file or path is an empty string. ELOOP A loop exists in symbolic links encountered during resolution of the path argument. ENAMETOOLONG The length of path exceeds {PATH_MAX}, or a pathname component is longer than {NAME_MAX} while _POSIX_NO_TRUNC is in effect. ENOTDIR A component of the path prefix is not a directory. ENOSYS The file system does not support symbolic links. The readlink() function may fail if: EACCES Read permission is denied for the directory. ELOOP More than {SYMLOOP_MAX} symbolic links were encountered in resolving path. ENAMETOOLONG As a result of encountering a symbolic link in resolution of the path argument, the length of the substituted pathname string exceeded {PATH_MAX}. USAGE
Portable applications should not assume that the returned contents of the symbolic link are null-terminated. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |Async-Signal-Safe | +-----------------------------+-----------------------------+ SEE ALSO
stat(2), symlink(2), attributes(5), standards(5) SunOS 5.10 1 Dec 2003 readlink(2)

Check Out this Related Man Page

resolvepath(2)							   System Calls 						    resolvepath(2)

NAME
resolvepath - resolve all symbolic links of a path name SYNOPSIS
#include <unistd.h> int resolvepath(const char *path, char *buf, size_t bufsiz); DESCRIPTION
The resolvepath() function fully resolves all symbolic links in the path name path into a resulting path name free of symbolic links and places the resulting path name in the buffer buf which has size bufsiz. The resulting path name names the same file or directory as the original path name. All ``.'' components are eliminated and every non-leading ``..'' component is eliminated together with its preceding directory component. If leading ``..'' components reach to the root directory, they are replaced by ``/''. If the number of bytes in the resulting path name is less than bufsiz, the contents of the remainder of buf are unspecified. RETURN VALUES
Upon successful completion, resolvepath() returns the count of bytes placed in the buffer. Otherwise, it returns -1, leaves the buffer unchanged, and sets errno to indicate the error. ERRORS
The resolvepath() function will fail if: EACCES Search permission is denied for a component of the path prefix of path or for a path prefix component resulting from the resolution of a symbolic link. EFAULT The path or buf argument points to an illegal address. EIO An I/O error occurred while reading from the file system. ENOENT The path argument is an empty string or a component of path or a path name component produced by resolving a sym- bolic link does not name an existing file. ELOOP Too many symbolic links were encountered in resolving path. ENAMETOOLONG The length of path exceeds PATH_MAX, or a path name component is longer than NAME_MAX. Path name resolution of a symbolic link produced an intermediate result whose length exceeds PATH_MAX or a component whose length exceeds NAME_MAX. ENOTDIR A component of the path prefix of path or of a path prefix component resulting from the resolution of a symbolic link is not a directory. USAGE
No more than PATH_MAX bytes will be placed in the buffer. Applications should not assume that the returned contents of the buffer are null- terminated. SEE ALSO
readlink(2), realpath(3C) SunOS 5.10 12 May 1997 resolvepath(2)
Man Page