man7.org > Linux > man-pages

Linux/UNIX system programming training

getdirentries(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | STANDARDS | NOTES | SEE ALSO | COLOPHON 

getdirentries(3)        Library Functions Manual        getdirentries(3)

NAME         top

       getdirentries - get directory entries in a filesystem-independent
       format

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <dirent.h>

       ssize_t getdirentries(int fd, char buf[restrict .nbytes], size_t nbytes,
                             off_t *restrict basep);

   Feature Test Macro Requirements for glibc (see
   feature_test_macros(7)):

       getdirentries():
           Since glibc 2.19:
               _DEFAULT_SOURCE
           glibc 2.19 and earlier:
               _BSD_SOURCE || _SVID_SOURCE

DESCRIPTION         top

       Read directory entries from the directory specified by fd into
       buf.  At most nbytes are read.  Reading starts at offset *basep,
       and *basep is updated with the new position after reading.

RETURN VALUE         top

       getdirentries() returns the number of bytes read or zero when at
       the end of the directory.  If an error occurs, -1 is returned,
       and errno is set to indicate the error.

ERRORS         top

       See the Linux library source code for details.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           │ Attribute     │ Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ getdirentries()                     │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       BSD.

NOTES         top

       Use opendir(3) and readdir(3) instead.

SEE ALSO         top

       lseek(2), open(2)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02               getdirentries(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI