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

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



NAME    [Toc]    [Back]

       getdents - get directory entries

SYNOPSIS    [Toc]    [Back]

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

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

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

DESCRIPTION    [Toc]    [Back]

       getdents  reads several dirent structures from the directory pointed at
       by fd into the memory area pointed to by dirp.  The parameter count  is
       the size of the memory area.

       The dirent structure is declared as follows:

	      struct dirent
		  long d_ino;		      /* inode number */
		  off_t d_off;		      /* offset to next dirent */
		  unsigned short d_reclen;    /* length of this dirent */
		  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 the start of the next dirent.  d_reclen  is  the  size  of
       this entire dirent.  d_name is a null-terminated file name.

       This call supersedes readdir(2).

RETURN VALUE    [Toc]    [Back]

       On success, the number of bytes read 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]

       SVr4, SVID.  SVr4 documents additional ENOLINK, EIO error conditions.

SEE ALSO    [Toc]    [Back]

       readdir(2), readdir(3)

Linux 1.3.6			  1995-07-22			   GETDENTS(2)
[ Back ]
 Similar pages
Name OS Title
dirent HP-UX format of directory streams and directory entries
rm FreeBSD remove directory entries
unlink FreeBSD remove directory entries
rm OpenBSD remove directory entries
scandir Linux scan a directory for matching entries
getdirentries OpenBSD get directory entries in a filesystem independent format
getdirentri HP-UX get entries from a directory in a file-systemindependent format
getdirentries Linux get directory entries in a filesystem independent format
getdirentries NetBSD get directory entries in a filesystem independent format
getdents NetBSD get directory entries in a filesystem independent format
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service