1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)getdirentries.2 8.2 (Berkeley) 5/3/95
33 .\" $FreeBSD: src/lib/libc/sys/getdirentries.2,v 1.12.2.6 2001/12/14 18:34:00 ru Exp $
34 .\" $DragonFly: src/lib/libc/sys/getdirentries.2,v 1.8 2007/12/23 15:31:28 swildner Exp $
42 .Nd "get directory entries in a filesystem independent format"
49 .Fn getdirentries "int fd" "char *buf" "int nbytes" "long *basep"
51 .Fn getdents "int fd" "char *buf" "int nbytes"
53 .Fn _DIRENT_DIRSIZ "struct dirent *dp"
55 .Fn _DIRENT_NEXT "struct dirent *dp"
61 functions read directory entries from the directory
62 referenced by the file descriptor
64 into the buffer pointed to by
66 in a filesystem independent format.
69 of data will be transferred.
72 argument must be greater than or equal to the
73 block size associated with the file,
76 Some filesystems may not support these functions
77 with buffers smaller than this size.
79 The data in the buffer is a series of
81 structures each containing the following entries:
82 .Bd -literal -offset indent
86 char d_name[...]; /* see below */
91 entry is a number which is unique for each
92 distinct file in the filesystem.
93 Files that are linked by hard links (see
99 entry is the type of the file pointed to by the directory record.
100 The file type values are defined in
104 entry contains a null terminated file name.
107 entry specifies the length of the file name excluding the null byte.
108 Thus the actual size of
114 Entries may be separated by extra space.
115 To get the total size of a
121 to get a pointer to the following
125 The actual number of bytes transferred is returned.
126 The current position pointer associated with
128 is set to point to the next block of entries.
129 The pointer may not advance by the number of bytes returned by
133 A value of zero is returned when
134 the end of the directory has been reached.
138 function writes the position of the block read into the location pointed to by
140 Alternatively, the current position pointer may be set and retrieved by
142 The current position pointer should only be set to a value returned by
144 a value returned in the location pointed to by
146 .Pf ( Fn getdirentries
150 If successful, the number of bytes actually transferred is returned.
151 Otherwise, -1 is returned and the global variable
153 is set to indicate the error.
160 is not a valid file descriptor open for reading.
166 point outside the allocated address space.
168 The file referenced by
170 is not a directory, or
172 is too small for returning a directory entry or block of entries,
173 or the current position pointer is invalid.
177 error occurred while reading from or writing to the file system.
185 function first appeared in
189 function first appeared in
194 is only 32 bits wide on 32 bit platforms and
195 may not be wide enough to accommodate the directory position cookie.
196 Modern users should use
198 to retrieve and set the seek position within the directory.
199 The seek offset is 64 bits wide on all platforms.