NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | USAGE | ATTRIBUTES | SEE ALSO
#include <unistd.h>int readlink(const char *path, char *buf, size_t bufsiz);
The readlink() function places the contents of the symbolic link referred to by path in the buffer buf which has size bufsiz. If the number 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.
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.
The readlink() function will fail if:
Search permission is denied for a component of the path prefix of path.
path or buf points to an illegal address.
The path argument names a file that is not a symbolic link.
An I/O error occurred while reading from the file system.
A component of path does not name an existing file or path is an empty string.
A loop exists in symbolic links encountered during resolution of the path argument.
The length of path exceeds {PATH_MAX}, or a pathname component is longer than {NAME_MAX} while _POSIX_NO_TRUNC is in effect.
A component of the path prefix is not a directory.
The file system does not support symbolic links.
The readlink() function may fail if:
Read permission is denied for the directory. This condition is reported.
More than {SYMLOOP_MAX} symbolic links were encountered in resolving path. This condition is reported.
As a result of encountering a symbolic link in resolution of the path argument, the length of the substituted pathname string exceeded {PATH_MAX}. This condition is reported.
Portable applications should not assume that the returned contents of the symbolic link are null-terminated.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Interface Stability | Standard |
MT-Level | Async-Signal-Safe |
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | USAGE | ATTRIBUTES | SEE ALSO