| getdirentries.2 (107788) | getdirentries.2 (108028) |
|---|---|
| 1.\" Copyright (c) 1989, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. --- 16 unchanged lines hidden (view full) --- 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 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)getdirentries.2 8.2 (Berkeley) 5/3/95 | 1.\" Copyright (c) 1989, 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. --- 16 unchanged lines hidden (view full) --- 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 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)getdirentries.2 8.2 (Berkeley) 5/3/95 |
| 33.\" $FreeBSD: head/lib/libc/sys/getdirentries.2 107788 2002-12-12 17:26:04Z ru $ | 33.\" $FreeBSD: head/lib/libc/sys/getdirentries.2 108028 2002-12-18 09:22:32Z ru $ |
| 34.\" 35.Dd May 3, 1995 36.Dt GETDIRENTRIES 2 37.Os 38.Sh NAME 39.Nm getdirentries , 40.Nm getdents 41.Nd "get directory entries in a file system independent format" --- 6 unchanged lines hidden (view full) --- 48.Fn getdirentries "int fd" "char *buf" "int nbytes" "long *basep" 49.Ft int 50.Fn getdents "int fd" "char *buf" "int nbytes" 51.Sh DESCRIPTION 52The 53.Fn getdirentries 54and 55.Fn getdents | 34.\" 35.Dd May 3, 1995 36.Dt GETDIRENTRIES 2 37.Os 38.Sh NAME 39.Nm getdirentries , 40.Nm getdents 41.Nd "get directory entries in a file system independent format" --- 6 unchanged lines hidden (view full) --- 48.Fn getdirentries "int fd" "char *buf" "int nbytes" "long *basep" 49.Ft int 50.Fn getdents "int fd" "char *buf" "int nbytes" 51.Sh DESCRIPTION 52The 53.Fn getdirentries 54and 55.Fn getdents |
| 56functions read directory entries from the directory | 56system calls read directory entries from the directory |
| 57referenced by the file descriptor 58.Fa fd 59into the buffer pointed to by 60.Fa buf , 61in a file system independent format. 62Up to 63.Fa nbytes 64of data will be transferred. 65The 66.Fa nbytes 67argument must be greater than or equal to the 68block size associated with the file, 69see 70.Xr stat 2 . | 57referenced by the file descriptor 58.Fa fd 59into the buffer pointed to by 60.Fa buf , 61in a file system independent format. 62Up to 63.Fa nbytes 64of data will be transferred. 65The 66.Fa nbytes 67argument must be greater than or equal to the 68block size associated with the file, 69see 70.Xr stat 2 . |
| 71Some file systems may not support these functions | 71Some file systems may not support these system calls |
| 72with buffers smaller than this size. 73.Pp 74The data in the buffer is a series of 75.Em dirent 76structures each containing the following entries: 77.Bd -literal -offset indent 78u_int32_t d_fileno; 79u_int16_t d_reclen; --- 45 unchanged lines hidden (view full) --- 125.Fn getdirentries 126or 127.Fn getdents . 128A value of zero is returned when 129the end of the directory has been reached. 130.Pp 131The 132.Fn getdirentries | 72with buffers smaller than this size. 73.Pp 74The data in the buffer is a series of 75.Em dirent 76structures each containing the following entries: 77.Bd -literal -offset indent 78u_int32_t d_fileno; 79u_int16_t d_reclen; --- 45 unchanged lines hidden (view full) --- 125.Fn getdirentries 126or 127.Fn getdents . 128A value of zero is returned when 129the end of the directory has been reached. 130.Pp 131The 132.Fn getdirentries |
| 133function writes the position of the block read into the location pointed to by | 133system call writes the position of the block read into the location pointed to by |
| 134.Fa basep . 135Alternatively, the current position pointer may be set and retrieved by 136.Xr lseek 2 . 137The current position pointer should only be set to a value returned by 138.Xr lseek 2 , 139a value returned in the location pointed to by 140.Fa basep | 134.Fa basep . 135Alternatively, the current position pointer may be set and retrieved by 136.Xr lseek 2 . 137The current position pointer should only be set to a value returned by 138.Xr lseek 2 , 139a value returned in the location pointed to by 140.Fa basep |
| 141.Pf ( Fn getdirentries | 141.Fn ( getdirentries |
| 142only) 143or zero. 144.Sh RETURN VALUES 145If successful, the number of bytes actually transferred is returned. 146Otherwise, -1 is returned and the global variable 147.Va errno 148is set to indicate the error. 149.Sh ERRORS | 142only) 143or zero. 144.Sh RETURN VALUES 145If successful, the number of bytes actually transferred is returned. 146Otherwise, -1 is returned and the global variable 147.Va errno 148is set to indicate the error. 149.Sh ERRORS |
| 150.Fn Getdirentries | 150The 151.Fn getdirentries 152system call |
| 151will fail if: 152.Bl -tag -width Er 153.It Bq Er EBADF 154.Fa fd 155is not a valid file descriptor open for reading. 156.It Bq Er EFAULT 157Either 158.Fa buf --- 13 unchanged lines hidden (view full) --- 172error occurred while reading from or writing to the file system. 173.El 174.Sh SEE ALSO 175.Xr lseek 2 , 176.Xr open 2 177.Sh HISTORY 178The 179.Fn getdirentries | 153will fail if: 154.Bl -tag -width Er 155.It Bq Er EBADF 156.Fa fd 157is not a valid file descriptor open for reading. 158.It Bq Er EFAULT 159Either 160.Fa buf --- 13 unchanged lines hidden (view full) --- 174error occurred while reading from or writing to the file system. 175.El 176.Sh SEE ALSO 177.Xr lseek 2 , 178.Xr open 2 179.Sh HISTORY 180The 181.Fn getdirentries |
| 180function first appeared in | 182system call first appeared in |
| 181.Bx 4.4 . 182The 183.Fn getdents | 183.Bx 4.4 . 184The 185.Fn getdents |
| 184function first appeared in | 186system call first appeared in |
| 185.Fx 3.0 . | 187.Fx 3.0 . |