*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> readdir (2)              



NAME    [Toc]    [Back]

       readdir - read directory entry

SYNOPSIS    [Toc]    [Back]

       #include <unistd.h>
       #include <linux/dirent.h>
       #include <linux/unistd.h>

       _syscall3(int, readdir, uint, fd, struct dirent *, dirp, uint, count);

       int readdir(unsigned int fd, struct dirent *dirp, unsigned int count);

DESCRIPTION    [Toc]    [Back]

       This is not the function you are interested in.	Look at readdir(3) for
       the POSIX conforming C library interface.  This page documents the bare
       kernel system call interface, which can change, and which is superseded
       by getdents(2).

       readdir reads one dirent structure from the directory pointed at by  fd
       into  the  memory  area	pointed  to  by  dirp.	The parameter count is
       ignored; at most one dirent structure is read.

       The dirent structure is declared as follows:

	      struct dirent
		  long d_ino;		      /* inode number */
		  off_t d_off;		      /* offset to this dirent */
		  unsigned short d_reclen;    /* length of this d_name */
		  char d_name [NAME_MAX+1];   /* file name (null-terminated) */

       d_ino is an inode number.  d_off is the distance from the start of  the
       directory to this dirent.  d_reclen is the size of d_name, not counting
       the null terminator.  d_name is a null-terminated file name.

RETURN VALUE    [Toc]    [Back]

       On success, 1 is returned.  On end of directory,  0  is	returned.   On
       error, -1 is returned, and errno is set appropriately.

ERRORS    [Toc]    [Back]

       EBADF  Invalid file descriptor fd.

       EFAULT Argument points outside the calling process's address space.

       EINVAL Result buffer is too small.

       ENOENT No such directory.

       ENOTDIR    [Toc]    [Back]
	      File descriptor does not refer to a directory.

CONFORMING TO    [Toc]    [Back]

       This system call is Linux specific.

SEE ALSO    [Toc]    [Back]

       getdents(2), readdir(3)

Linux 1.3.6			  1995-07-22			    READDIR(2)
[ Back ]
 Similar pages
Name OS Title
cddrec Tru64 Read Directory Record from CD-ROM directory
readdir Linux read a directory
csa_read_entry_attributes HP-UX read and return the calendar entry attribute values for a specified calendar entry
VOP_READDIR FreeBSD read contents of a directory
delete_replica HP-UX Deletes a read-only replica of a directory from a clearinghouse
getdents IRIX read directory entries and put in a file system independent format
pax OpenBSD read and write file archives and copy directory hierarchies
pax FreeBSD read and write file archives and copy directory hierarchies
DXmSvnSetComponentText Tru64 Adds a read-only component string to an entry.
gconfigger Linux Tool to change/read GNOME configuration entry.
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service