Linux manual pages Section 3  

Name

dirfd — get directory stream file descriptor

Synopsis

#include <sys/types.h>
#include <dirent.h>
int dirfd( DIR *dirp);
 
[Note] Note
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
dirfd():
_BSD_SOURCE || _SVID_SOURCE
|| /* Since glibc 2.10: */
(_POSIX_C_SOURCE >= 200809L || _XOPEN_SOURCE >= 700)

DESCRIPTION

The function dirfd() returns the file descriptor associated with the directory stream dirp.

This descriptor is the one used internally by the directory stream. As a result, it is only useful for functions which do not depend on or alter the file position, such as fstat(2) and fchdir(2). It will be automatically closed when closedir(3) is called.

RETURN VALUE

On success, a nonnegative file descriptor is returned. On error, −1 is returned.

ERRORS

POSIX.1-2008 specifies two errors, neither of which is returned by the current implementation.

EINVAL

dirp does not refer to a valid directory stream.

ENOTSUP

The implementation does not support the association of a file descriptor with a directory.

CONFORMING TO

POSIX.1-2008. This function was a BSD extension, present in 4.3BSD-Reno, not in 4.2BSD.

NOTES

The prototype for dirfd() is only available if _BSD_SOURCE or _SVID_SOURCE is defined.

SEE ALSO

open(2), closedir(3), opendir(3), readdir(3), rewinddir(3), scandir(3), seekdir(3), telldir(3)

COLOPHON

This page is part of release 3.33 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://man7.org/linux/man-pages/.


  Copyright (C) 2002 Andries Brouwer (aebcwi.nl)

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.