[linuxjm/LDP_man-pages.git] / draft / man2 / readdir.2

.\" 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.
.\"
.\" 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.
.\"
.\" 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>:
.\"   In 1.3.X, returns only one entry each time; return value is different.
.\" Modified 2004-12-01, mtk, fixed headers listed in SYNOPSIS
.\"
.\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
.\"         all rights reserved.
.\" Translated Sun Feb 23 21:06:24 JST 1997
.\"         by HANATAKA Shinya <hanataka@abyss.rim.or.jp>
.\"
.\"WORD:        directory               ¥Ç¥£¥ì¥¯¥È¥ê
.\"WORD:        entry                   ¥¨¥ó¥È¥ê
.\"WORD:        kernel                  ¥«¡¼¥Í¥ë
.\"WORD:        system call             ¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë
.\"WORD:        memory                  ¥á¥â¥ê
.\"WORD:        inode number            inode ÈÖ¹æ
.\"WORD:        null                    ¥Ì¥ëʸ»ú
.\"
.TH READDIR 2  2008-10-02 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O readdir \- read directory entry
readdir \- ¥Ç¥£¥ì¥¯¥È¥ê¡¦¥¨¥ó¥È¥ê¤òÆɤ߹þ¤à
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
.sp
.BI "int readdir(unsigned int " fd ", struct old_linux_dirent *" dirp ","
.BI "            unsigned int " count );
.fi
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O This is not the function you are interested in.
.\"O Look at
.\"O .BR readdir (3)
.\"O for the POSIX conforming C library interface.
.\"O This page documents the bare kernel system call interface,
.\"O which is superseded by
.\"O .BR getdents (2).
¤³¤ì¤Ï¤¢¤Ê¤¿¤Î¶½Ì£¤ò¤â¤Ã¤Æ¤¤¤ë´Ø¿ô¤Ç¤Ï¤Ê¤¤¡£
POSIX ½àµò¤Î C ¥é¥¤¥Ö¥é¥ê¡¦¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹¤Ë¤Ä¤¤¤Æ¤Ï
.BR readdir (3)
¤ò¸«¤ë¤³¤È¡£
¤³¤Î¥Ú¡¼¥¸¤ÏÍç¤Î¥«¡¼¥Í¥ë¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¡¦¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹¤Ë¤Ä¤¤¤Æ
µ­½Ò¤·¤Æ¤¤¤ë¤¬¡¢¤³¤Î¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹¤Ï
.BR getdents (2)
¤Ë¤è¤Ã¤Æ¼è¤Ã¤ÆÂå¤ï¤é¤ì¤¿¡£
.PP
.\"O .BR readdir ()
.\"O reads one
.\"O .I old_linux_dirent
.\"O structure from the directory
.\"O referred to by the file descriptor
.\"O .I fd
.\"O into the buffer pointed to by
.\"O .IR dirp .
.\"O The argument
.\"O .I count
.\"O is ignored; at most one
.\"O .I old_linux_dirent
.\"O structure is read.
.BR readdir ()
¤Ï¡¢¥Õ¥¡¥¤¥ë¥Ç¥£¥¹¥¯¥ê¥×¥¿
.I fd
¤¬»²¾È¤·¤Æ¤¤¤ë¥Ç¥£¥ì¥¯¥È¥ê¤«¤é
.I old_linux_dirent
¹½Â¤ÂΤòÆɤ߹þ¤ß¡¢
.I dirp
¤Ç»Ø¤µ¤ì¤¿¥Ð¥Ã¥Õ¥¡¤Ë³ÊǼ¤¹¤ë¡£
.I count
°ú¤­¿ô¤Ï(¤Û¤È¤ó¤É¤Î
.I old_linux_dirent
¹½Â¤ÂΤÎÆɤ߹þ¤ß¤Ë¤ª¤¤¤Æ)̵»ë¤µ¤ì¤ë
.PP
.\"O The
.\"O .I old_linux_dirent
.\"O structure is declared as follows:
.I old_linux_dirent
¹½Â¤ÂΤϰʲ¼¤Î¤è¤¦¤ËÀë¸À¤µ¤ì¤ë:
.PP
.in +4n
.nf
struct old_linux_dirent {
    long  d_ino;              /* inode number */
    off_t d_off;              /* offset to this \fIold_linux_dirent\fP */
    unsigned short d_reclen;  /* length of this \fId_name\fP */
    char  d_name[NAME_MAX+1]; /* filename (null-terminated) */
}
.fi
.in
.PP
.\"O .I d_ino
.\"O is an inode number.
.\"O .I d_off
.\"O is the distance from the start of the directory to this
.\"O .IR old_linux_dirent .
.\"O .I d_reclen
.\"O is the size of
.\"O .IR d_name ,
.\"O not counting the null terminator.
.\"O .I d_name
.\"O is a null-terminated filename.
.I d_ino
¤Ï inode ÈÖ¹æ¤Ç¤¢¤ë¡£
.I d_off
¤Ï¥Ç¥£¥ì¥¯¥È¥ê¤ÎºÇ½é¤«¤é¤³¤Î
.I old_linux_dirent
¤Þ¤Çµ÷Î¥¤Ç¤¢¤ë¡£
.I d_reclen
¤Ï
.I d_name
¤ÎÂ礭¤µ¤Ç¡¢
¥Ì¥ëʸ»ú¤Î½ªÃ¼¤ò´Þ¤ó¤Ç¤¤¤Ê¤¤¡£
.I d_name
¤Ï¥Ì¥ëʸ»ú¤Ç½ª¤ë¥Õ¥¡¥¤¥ë̾¤Ç¤¢¤ë¡£
.\"O .SH "RETURN VALUE"
.SH ÊÖ¤êÃÍ
.\"O On success, 1 is returned.
.\"O On end of directory, 0 is returned.
.\"O On error, \-1 is returned, and
.\"O .I errno
.\"O is set appropriately.
À®¸ù¤·¤¿¾ì¹ç¤Ï¡¢1 ¤¬ÊÖ¤µ¤ì¤ë¡£
¥Ç¥£¥ì¥¯¥È¥ê¤ÎºÇ¸å¤Ç¤Ï 0 ¤¬ÊÖ¤µ¤ì¤ë¡£
¥¨¥é¡¼¤Î¾ì¹ç¤Ï \-1 ¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤¬Å¬ÀÚ¤ËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.B EBADF
.\"O Invalid file descriptor
.\"O .IR fd .
¥Õ¥¡¥¤¥ë¡¦¥Ç¥£¥¹¥¯¥ê¥×¥¿¡¼
.I fd
¤¬ÉÔÀµ¤Ç¤¢¤ë¡£
.TP
.B EFAULT
.\"O Argument points outside the calling process's address space.
°ú¤­¿ô¤Î¥Ý¥¤¥ó¥¿¡¼¤¬¸Æ¤Ó½Ð¤·¤¿¥×¥í¥»¥¹¤¬¥¢¥¯¥»¥¹²Äǽ¤Ê¶õ´Ö¤Î
³°Éô¤ò»Ø¤·¤Æ¤¤¤ë¡£
.TP
.B EINVAL
.\"O Result buffer is too small.
·ë²ÌÍѤΥХåե¡¡¼¤¬¾®¤µ²á¤®¤ë¡£
.TP
.B ENOENT
.\"O No such directory.
¤½¤Î¤è¤¦¤Ê¥Ç¥£¥ì¥¯¥È¥ê¤Ï¸ºß¤·¤Ê¤¤¡£
.TP
.B ENOTDIR
.\"O File descriptor does not refer to a directory.
¥Õ¥¡¥¤¥ë¡¦¥Ç¥£¥¹¥¯¥ê¥×¥¿¡¼¤¬¥Ç¥£¥ì¥¯¥È¥ê¤ò»²¾È¤·¤Æ¤¤¤Ê¤¤¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
.\"O This system call is Linux-specific.
¤³¤Î¥·¥¹¥Æ¥à¡¦¥³¡¼¥ë¤Ï Linux ÆÃÍ­¤Ç¤¢¤ë¡£
.\"O .SH NOTES
.SH Ãí°Õ
.\"O Glibc does not provide a wrapper for this system call; call it using
.\"O .BR syscall (2).
glibc ¤Ï¤³¤Î¥·¥¹¥Æ¥à¥³¡¼¥ë¤ËÂФ¹¤ë¥é¥Ã¥Ñ¡¼´Ø¿ô¤òÄ󶡤·¤Æ¤¤¤Ê¤¤¡£
.BR syscall (2)
¤ò»È¤Ã¤Æ¸Æ¤Ó½Ð¤¹¤³¤È¡£
.\"O You will need to define the
.\"O .I old_linux_dirent
.\"O structure yourself.
.I old_linux_dirent
¹½Â¤ÂΤò¼«Ê¬¼«¿È¤ÇÄêµÁ¤¹¤ëɬÍפ¬¤¢¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR getdents (2),
.BR readdir (3)