mirror of https://github.com/mkerrisk/man-pages
75 lines
2.3 KiB
Groff
75 lines
2.3 KiB
Groff
.\" Hey Emacs! This file is -*- nroff -*- source.
|
|
.\"
|
|
.\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
|
|
.\" Portions extracted from /usr/include/dirent.h are:
|
|
.\" Copyright 1991, 1992 Free Software Foundation
|
|
.\"
|
|
.\" 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.
|
|
.\"
|
|
.TH GETDIRENTRIES 3 2007-07-26 "GNU" "Linux Programmer's Manual"
|
|
.SH NAME
|
|
getdirentries \- get directory entries in a file system-independent format
|
|
.SH SYNOPSIS
|
|
.B #include <dirent.h>
|
|
.sp
|
|
.BI "ssize_t getdirentries(int " fd ", char *" buf ", size_t " nbytes
|
|
.BI ", off_t *" basep );
|
|
.sp
|
|
.in -4n
|
|
Feature Test Macro Requirements for glibc (see
|
|
.BR feature_test_macros (7)):
|
|
.in
|
|
.sp
|
|
.BR getdirentries ():
|
|
_BSD_SOURCE || _SVID_SOURCE
|
|
.SH DESCRIPTION
|
|
Read directory entries from the directory specified by
|
|
.I fd
|
|
into
|
|
.IR buf .
|
|
At most
|
|
.I nbytes
|
|
are read.
|
|
Reading starts at offset
|
|
.IR *basep ,
|
|
and
|
|
.I *basep
|
|
is updated with the new position after reading.
|
|
.SH "RETURN VALUE"
|
|
.BR getdirentries ()
|
|
returns the number of bytes read or zero when at the end of the directory.
|
|
If an error occurs, \-1 is returned, and
|
|
.I errno
|
|
is set appropriately.
|
|
.SH ERRORS
|
|
See the Linux library source code for details.
|
|
.SH "CONFORMING TO"
|
|
Not in POSIX.1-2001.
|
|
Present on the BSDs, and a few other systems.
|
|
Use
|
|
.BR opendir (3)
|
|
and
|
|
.BR readdir (3)
|
|
instead.
|
|
.SH "SEE ALSO"
|
|
.BR lseek (2),
|
|
.BR open (2)
|