getdirentries(3) [hpux man page]

GETDIRENTRIES(3)                                             Linux Programmer's Manual                                            GETDIRENTRIES(3)

NAME

       getdirentries - get directory entries in a filesystem-independent format

SYNOPSIS

       #include <dirent.h>

       ssize_t getdirentries(int fd, char *buf, size_t nbytes , off_t *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 appropriately.

ERRORS

       See the Linux library source code for details.

ATTRIBUTES

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

       +----------------+---------------+---------+
       |Interface       | Attribute     | Value   |
       +----------------+---------------+---------+
       |getdirentries() | Thread safety | MT-Safe |
       +----------------+---------------+---------+
CONFORMING TO

       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)

COLOPHON

       This  page is part of release 4.15 of the Linux man-pages project.  A description of the project, information about reporting bugs, and the
       latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

GNU                                                                 2016-03-15                                                    GETDIRENTRIES(3)

GETDIRENTRIES(2)					      BSD System Calls Manual						  GETDIRENTRIES(2)

NAME

     getdirentries, getdents -- get directory entries in a file system independent format

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <sys/types.h>
     #include <dirent.h>

     int
     getdirentries(int fd, char *buf, int nbytes, long *basep);

     int
     getdents(int fd, char *buf, int nbytes);

DESCRIPTION

     The getdirentries() and getdents() system calls read directory entries from the directory referenced by the file descriptor fd into the buf-
     fer pointed to by buf, in a file system independent format.  Up to nbytes of data will be transferred.  The nbytes argument must be greater
     than or equal to the block size associated with the file, see stat(2).  Some file systems may not support these system calls with buffers
     smaller than this size.

     The data in the buffer is a series of dirent structures each containing the following entries:

	   uint32_t d_fileno;
	   uint16_t d_reclen;
	   uint8_t  d_type;
	   uint8_t  d_namlen;
	   char    d_name[MAXNAMELEN + 1]; /* see below */

     The d_fileno entry is a number which is unique for each distinct file in the file system.	Files that are linked by hard links (see link(2))
     have the same d_fileno.  The d_reclen entry is the length, in bytes, of the directory record.  The d_type entry is the type of the file
     pointed to by the directory record.  The file type values are defined in <sys/dirent.h>.  The d_name entry contains a null terminated file
     name.  The d_namlen entry specifies the length of the file name excluding the null byte.  Thus the actual size of d_name may vary from 1 to
     MAXNAMELEN + 1.

     Entries may be separated by extra space.  The d_reclen entry may be used as an offset from the start of a dirent structure to the next struc-
     ture, if any.

     The actual number of bytes transferred is returned.  The current position pointer associated with fd is set to point to the next block of
     entries.  The pointer may not advance by the number of bytes returned by getdirentries() or getdents().  A value of zero is returned when the
     end of the directory has been reached.

     The getdirentries() system call writes the position of the block read into the location pointed to by basep.  Alternatively, the current
     position pointer may be set and retrieved by lseek(2).  The current position pointer should only be set to a value returned by lseek(2), a
     value returned in the location pointed to by basep (getdirentries() only) or zero.

RETURN VALUES

     If successful, the number of bytes actually transferred is returned.  Otherwise, -1 is returned and the global variable errno is set to indi-
     cate the error.

ERRORS

     The getdirentries() system call will fail if:

     [EBADF]		The fd argument is not a valid file descriptor open for reading.

     [EFAULT]		Either buf or basep point outside the allocated address space.

     [EINVAL]		The file referenced by fd is not a directory, or nbytes is too small for returning a directory entry or block of entries,
			or the current position pointer is invalid.

     [EIO]		An I/O error occurred while reading from or writing to the file system.

SEE ALSO

     lseek(2), open(2)

HISTORY

     The getdirentries() system call first appeared in 4.4BSD.	The getdents() system call first appeared in FreeBSD 3.0.

BSD
								    May 3, 1995 							       BSD