getdirentries - Man Page

get directory entries in a filesystem-independent format

Library

Standard C library (libc, -lc)

Synopsis

#include <dirent.h>

ssize_t getdirentries(int fd, char *restrict buf, 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

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

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

See the Linux library source code for details.

Attributes

For an explanation of the terms used in this section, see attributes(7).

InterfaceAttributeValue
getdirentries()Thread safetyMT-Safe

Standards

Not in POSIX.1. Present on the BSDs, and a few other systems. Use opendir(3) and readdir(3) instead.

See Also

lseek(2), open(2)

Info

2022-10-09 Linux man-pages 6.01