readlink man page on NetBSD

Man page or keyword search:  
man Server   9087 pages
apropos Keyword Search (all sections)
Output format
NetBSD logo
[printable version]

READLINK(2)		    BSD System Calls Manual		   READLINK(2)

NAME
     readlink — read value of a symbolic link

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <unistd.h>

     ssize_t
     readlink(const char * restrict path, char * restrict buf, size_t bufsiz);

DESCRIPTION
     readlink() places the contents of the symbolic link path in the buffer
     buf, which has size bufsiz.  readlink() does not append a NUL character
     to buf.

RETURN VALUES
     The call returns the count of characters placed in the buffer if it suc‐
     ceeds, or a -1 if an error occurs, placing the error code in the global
     variable errno.

EXAMPLES
     A typical use is illustrated in the following piece of code which reads
     the contents of a symbolic link named /symbolic/link and stores them as
     null-terminated string:

	   #include <limits.h>
	   #include <unistd.h>

	   char buf[PATH_MAX];
	   ssize_t len;

	   if ((len = readlink("/symbolic/link", buf, sizeof(buf)-1)) == -1)
		   error handling;
	   buf[len] = '\0';

ERRORS
     readlink() will fail if:

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

     [ENAMETOOLONG]	A component of a pathname exceeded {NAME_MAX} charac‐
			ters, or an entire path name exceeded {PATH_MAX} char‐
			acters.

     [ENOENT]		The named file does not exist.

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

     [ELOOP]		Too many symbolic links were encountered in translat‐
			ing the pathname.

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

     [EIO]		An I/O error occurred while reading from the file sys‐
			tem.

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

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

STANDARDS
     The readlink() function conforms to IEEE Std 1003.1-2001 (“POSIX.1”).

HISTORY
     The readlink() function appeared in 4.2BSD.  The type returned was
     changed from int to ssize_t in NetBSD 2.1.

BSD				 May 11, 2004				   BSD
[top]
                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 
More information is available in HTML format for server NetBSD

List of man pages available for NetBSD

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net