man3/dirfd.3

   1 .\" Copyright (C) 2002 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH DIRFD 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 dirfd \- get directory stream file descriptor
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <sys/types.h>
  31 .B #include <dirent.h>
  32 .PP
  33 .BI "int dirfd(DIR *" dirp );
  34 .fi
  35 .PP
  36 .RS -4
  37 Feature Test Macro Requirements for glibc (see
  38 .BR feature_test_macros (7)):
  39 .RE
  40 .PP
  41 .BR dirfd ():
  42 .nf
  43     /* Since glibc 2.10: */ _POSIX_C_SOURCE >= 200809L
  44         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  45 .fi
  46 .SH DESCRIPTION
  47 The function
  48 .BR dirfd ()
  49 returns the file descriptor associated with the directory stream
  50 .IR dirp .
  51 .PP
  52 This file descriptor is the one used internally by the directory stream.
  53 As a result, it is useful only for functions which do not depend on
  54 or alter the file position, such as
  55 .BR fstat (2)
  56 and
  57 .BR fchdir (2).
  58 It will be automatically closed when
  59 .BR closedir (3)
  60 is called.
  61 .SH RETURN VALUE
  62 On success,
  63 .BR dirfd ()
  64 returns a file descriptor (a nonnegative integer).
  65 On error, \-1 is returned, and
  66 .I errno
  67 is set to indicate the error.
  68 .SH ERRORS
  69 POSIX.1-2008 specifies two errors,
  70 neither of which is returned by the current
  71 .\" glibc 2.8
  72 implementation.
  73 .TP
  74 .B EINVAL
  75 .I dirp
  76 does not refer to a valid directory stream.
  77 .TP
  78 .B ENOTSUP
  79 The implementation does not support the association of a file
  80 descriptor with a directory.
  81 .SH ATTRIBUTES
  82 For an explanation of the terms used in this section, see
  83 .BR attributes (7).
  84 .ad l
  85 .nh
  86 .TS
  87 allbox;
  88 lbx lb lb
  89 l l l.
  90 Interface       Attribute       Value
  91 T{
  92 .BR dirfd ()
  93 T}      Thread safety   MT-Safe
  94 .TE
  95 .hy
  96 .ad
  97 .sp 1
  98 .SH CONFORMING TO
  99 POSIX.1-2008.
 100 This function was a BSD extension, present in 4.3BSD-Reno, not in 4.2BSD.
 101 .\" It is present in libc5 (since 5.1.2) and in glibc2.
 102 .SH SEE ALSO
 103 .BR open (2),
 104 .BR openat (2),
 105 .BR closedir (3),
 106 .BR opendir (3),
 107 .BR readdir (3),
 108 .BR rewinddir (3),
 109 .BR scandir (3),
 110 .BR seekdir (3),
 111 .BR telldir (3)