2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (C) 1995 Andries Brouwer (aeb@cwi.nl)
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" Written 11 June 1995 by Andries Brouwer <aeb@cwi.nl>
|
|
|
|
.\" Modified 22 July 1995 by Michael Chastain <mec@duracef.shout.net>:
|
|
|
|
.\" Derived from 'readdir.2'.
|
|
|
|
.\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
|
2008-06-17 21:51:05 +00:00
|
|
|
.TH GETDENTS 2 2008-06-22 "Linux" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
getdents \- get directory entries
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <unistd.h>
|
|
|
|
.B #include <linux/types.h>
|
|
|
|
.B #include <linux/dirent.h>
|
|
|
|
.B #include <linux/unistd.h>
|
2004-12-10 09:03:08 +00:00
|
|
|
.B #include <errno.h>
|
2008-07-06 14:26:07 +00:00
|
|
|
|
|
|
|
.BI "int getdents(unsigned int " fd ", struct dirent *" dirp ,
|
|
|
|
.BI " unsigned int " count );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
|
|
|
This is not the function you are interested in.
|
|
|
|
Look at
|
|
|
|
.BR readdir (3)
|
|
|
|
for the POSIX conforming C library interface.
|
|
|
|
This page documents the bare kernel system call interface.
|
|
|
|
.PP
|
|
|
|
The system call
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR getdents ()
|
2007-04-12 22:42:49 +00:00
|
|
|
reads several
|
2004-11-03 13:51:07 +00:00
|
|
|
.I dirent
|
|
|
|
structures from the directory
|
2008-06-17 21:51:05 +00:00
|
|
|
referred to by the open file descriptor
|
2004-11-03 13:51:07 +00:00
|
|
|
.I fd
|
2008-06-17 21:51:05 +00:00
|
|
|
into the buffer pointed to by
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR dirp .
|
2008-07-10 20:53:08 +00:00
|
|
|
The argument
|
2004-11-03 13:51:07 +00:00
|
|
|
.I count
|
|
|
|
is the size of the memory area.
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I dirent
|
|
|
|
structure is declared as follows:
|
|
|
|
.PP
|
2007-12-23 14:14:04 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2008-06-17 21:51:05 +00:00
|
|
|
struct linux_dirent {
|
|
|
|
unsigned long d_ino; /* Inode number */
|
|
|
|
unsigned long d_off; /* Offset to next \fIdirent\fP */
|
|
|
|
unsigned short d_reclen; /* Length of this \fIdirent\fP */
|
|
|
|
char d_name []; /* Filename (null-terminated) */
|
2008-06-26 13:23:48 +00:00
|
|
|
/* length is actually (d_reclen \- 2 \-
|
2008-06-17 21:51:05 +00:00
|
|
|
offsetof(struct linux_dirent, d_name) */
|
2008-07-06 14:26:07 +00:00
|
|
|
char pad; /* Zero padding byte */
|
|
|
|
char d_type; /* File type (only since Linux 2.6.4;
|
2008-06-26 13:23:48 +00:00
|
|
|
offset is (d_reclen \- 1)) */
|
2008-06-17 21:51:05 +00:00
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
}
|
2007-12-23 21:05:57 +00:00
|
|
|
.fi
|
2007-12-23 14:14:04 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
.I d_ino
|
|
|
|
is an inode number.
|
|
|
|
.I d_off
|
|
|
|
is the distance from the start of the directory to the start of the next
|
|
|
|
.IR dirent .
|
|
|
|
.I d_reclen
|
|
|
|
is the size of this entire
|
|
|
|
.IR dirent .
|
|
|
|
.I d_name
|
2006-02-12 22:15:41 +00:00
|
|
|
is a null-terminated filename.
|
2008-06-17 21:51:05 +00:00
|
|
|
|
|
|
|
.I d_type
|
|
|
|
is a byte at the end of the structure that indicates the file type.
|
2008-06-27 12:07:36 +00:00
|
|
|
It contains one of the following values:
|
2008-06-17 21:51:05 +00:00
|
|
|
.TP 12
|
|
|
|
.B DT_BLK
|
|
|
|
This is a block device.
|
|
|
|
.TP
|
|
|
|
.B DT_CHR
|
|
|
|
This is a character device.
|
|
|
|
.TP
|
|
|
|
.B DT_DIR
|
|
|
|
This is a directory.
|
|
|
|
.TP
|
|
|
|
.B DT_FIFO
|
|
|
|
This is a named pipe (FIFO).
|
|
|
|
.TP
|
|
|
|
.B DT_LNK
|
|
|
|
This is a symbolic link.
|
|
|
|
.TP
|
|
|
|
.B DT_REG
|
|
|
|
This is a regular file.
|
|
|
|
.TP
|
|
|
|
.B DT_SOCK
|
|
|
|
This is a Unix domain socket.
|
|
|
|
.TP
|
|
|
|
.B DT_UNKNOWN
|
|
|
|
The file type is unknown.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
|
|
|
On success, the number of bytes read is returned.
|
|
|
|
On end of directory, 0 is returned.
|
|
|
|
On error, \-1 is returned, and
|
|
|
|
.I errno
|
|
|
|
is set appropriately.
|
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.B EBADF
|
|
|
|
Invalid file descriptor
|
|
|
|
.IR fd .
|
|
|
|
.TP
|
|
|
|
.B EFAULT
|
|
|
|
Argument points outside the calling process's address space.
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
|
|
|
Result buffer is too small.
|
|
|
|
.TP
|
|
|
|
.B ENOENT
|
|
|
|
No such directory.
|
|
|
|
.TP
|
|
|
|
.B ENOTDIR
|
|
|
|
File descriptor does not refer to a directory.
|
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:17 +00:00
|
|
|
SVr4.
|
|
|
|
.\" SVr4 documents additional ENOLINK, EIO error conditions.
|
2007-05-26 15:22:28 +00:00
|
|
|
.SH NOTES
|
|
|
|
Glibc does not provide a wrapper for this system call; call it using
|
|
|
|
.BR syscall (2).
|
2008-06-17 21:51:05 +00:00
|
|
|
|
|
|
|
This call supersedes
|
|
|
|
.BR readdir (2).
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR readdir (2),
|
|
|
|
.BR readdir (3)
|