summaryrefslogtreecommitdiff
path: root/reference/C/MAN/readdir.htm
blob: 39b3d239690ed5e6ed80ef0bdee32065795c20a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<TITLE>readdir</TITLE>
<body bgcolor="#ffffcc">
<hr>
<pre>



<h3>READDIR(2)          Linux Programmer's Manual          READDIR(2)
</h3>

<h3>NAME
</h3>       readdir - read directory entry

<h3>SYNOPSIS
</h3>       #include &lt;unistd.h&gt;
       #include &lt;linux/dirent.h&gt;
       #include &lt;linux/unistd.h&gt;

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

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

<h3>DESCRIPTION
</h3>       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 struc-
       ture 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.


<h3>RETURN VALUE
</h3>       On  success,  1  is  returned.   On end of directory, 0 is
       returned.  On error, -1 is  returned,  and  errno  is  set
       appropriately.

<h3>ERRORS
</h3>       EBADF  Invalid file descriptor fd.

       ENOTDIR
              File descriptor does not refer to a directory.

<h3>CONFORMING TO
</h3>       This system call is Linux specific.





<h3>Linux 1.3.6                22 July 1995                         1
</h3>




<h3>READDIR(2)          Linux Programmer's Manual          READDIR(2)
</h3>

</pre>
<hr>
<h3>SEE ALSO
</h3><p>
<a href=getdents.htm>getdents</a>, 
<a href=readdir.htm>readdir</a>, 
<pre>























































<h3>Linux 1.3.6                22 July 1995                         2
</h3>


</pre>
<P>
<hr>
<p>
<center>
<table border=2 width=80%>
<tr align=center>
<td width=25%>
<a href=../cref.html>Top</a>
</td><td width=25%>
<a href=../master_index.html>Master Index</a>
</td><td width=25%>
<a href=../SYNTAX/keywords.html>Keywords</a>
</td><td width=25%>
<a href=../FUNCTIONS/funcref.htm>Functions</a>
</td>
</tr>
</table>
</center>
<p>
<hr>

This manual page was brought to you by <i>mjl_man V-2.0</i>