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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)getdirentries.2 8.2 (Berkeley) 5/3/95
29 .\" $FreeBSD: src/lib/libc/sys/getdirentries.2,v 1.12.2.6 2001/12/14 18:34:00 ru Exp $
30 .\" $DragonFly: src/lib/libc/sys/getdirentries.2,v 1.8 2007/12/23 15:31:28 swildner Exp $
38 .Nd "get directory entries in a filesystem independent format"
45 .Fn getdirentries "int fd" "char *buf" "int nbytes" "long *basep"
47 .Fn getdents "int fd" "char *buf" "int nbytes"
49 .Fn _DIRENT_DIRSIZ "struct dirent *dp"
51 .Fn _DIRENT_NEXT "struct dirent *dp"
57 functions read directory entries from the directory
58 referenced by the file descriptor
60 into the buffer pointed to by
62 in a filesystem independent format.
65 of data will be transferred.
68 argument must be greater than or equal to the
69 block size associated with the file,
72 Some filesystems may not support these functions
73 with buffers smaller than this size.
75 The data in the buffer is a series of
77 structures each containing the following entries:
78 .Bd -literal -offset indent
82 char d_name[...]; /* see below */
87 entry is a number which is unique for each
88 distinct file in the filesystem.
89 Files that are linked by hard links (see
95 entry is the type of the file pointed to by the directory record.
96 The file type values are defined in
100 entry contains a null terminated file name.
103 entry specifies the length of the file name excluding the null byte.
104 Thus the actual size of
110 Entries may be separated by extra space.
111 To get the total size of a
117 to get a pointer to the following
121 The actual number of bytes transferred is returned.
122 The current position pointer associated with
124 is set to point to the next block of entries.
125 The pointer may not advance by the number of bytes returned by
129 A value of zero is returned when
130 the end of the directory has been reached.
134 function writes the position of the block read into the location pointed to by
136 Alternatively, the current position pointer may be set and retrieved by
138 The current position pointer should only be set to a value returned by
140 a value returned in the location pointed to by
142 .Pf ( Fn getdirentries
146 If successful, the number of bytes actually transferred is returned.
147 Otherwise, -1 is returned and the global variable
149 is set to indicate the error.
156 is not a valid file descriptor open for reading.
162 point outside the allocated address space.
164 The file referenced by
166 is not a directory, or
168 is too small for returning a directory entry or block of entries,
169 or the current position pointer is invalid.
173 error occurred while reading from or writing to the file system.
181 function first appeared in
185 function first appeared in
190 is only 32 bits wide on 32 bit platforms and
191 may not be wide enough to accommodate the directory position cookie.
192 Modern users should use
194 to retrieve and set the seek position within the directory.
195 The seek offset is 64 bits wide on all platforms.