original/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 2013-07-05 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 dirfd \- get directory stream file descriptor
  28 .SH SYNOPSIS
  29 .B #include <sys/types.h>
  30 .br
  31 .B #include <dirent.h>
  32 .sp
  33 .BI "int dirfd(DIR *" dirp );
  34 .sp
  35 .in -4n
  36 Feature Test Macro Requirements for glibc (see
  37 .BR feature_test_macros (7)):
  38 .in
  39 .sp
  40 .BR dirfd ():
  41 .br
  42 .RS 4
  43 .PD 0
  44 .ad l
  45 _BSD_SOURCE || _SVID_SOURCE
  46 .br
  47 || /* Since glibc 2.10: */
  48 .RS 4
  49 (_POSIX_C_SOURCE\ >=\ 200809L || _XOPEN_SOURCE\ >=\ 700)
  50 .RE
  51 .PD
  52 .RE
  53 .ad
  54 .SH DESCRIPTION
  55 The function
  56 .BR dirfd ()
  57 returns the file descriptor associated with the directory stream
  58 .IR dirp .
  59 .LP
  60 This descriptor is the one used internally by the directory stream.
  61 As a result, it is useful only for functions which do not depend on
  62 or alter the file position, such as
  63 .BR fstat (2)
  64 and
  65 .BR fchdir (2).
  66 It will be automatically closed when
  67 .BR closedir (3)
  68 is called.
  69 .SH RETURN VALUE
  70 On success, a nonnegative file descriptor is returned.
  71 On error, \-1 is returned, and
  72 .I errno
  73 is set to indicate the cause of the error.
  74 .SH ERRORS
  75 POSIX.1-2008 specifies two errors,
  76 neither of which is returned by the current
  77 .\" glibc 2.8
  78 implementation.
  79 .TP
  80 .B EINVAL
  81 .I dirp
  82 does not refer to a valid directory stream.
  83 .TP
  84 .B ENOTSUP
  85 The implementation does not support the association of a file
  86 descriptor with a directory.
  87 .SH ATTRIBUTES
  88 .SS Multithreading (see pthreads(7))
  89 The
  90 .BR dirfd ()
  91 function is thread-safe.
  92 .SH CONFORMING TO
  93 POSIX.1-2008.
  94 This function was a BSD extension, present in 4.3BSD-Reno, not in 4.2BSD.
  95 .\" It is present in libc5 (since 5.1.2) and in glibc2.
  96 .SH NOTES
  97 The prototype for
  98 .BR dirfd ()
  99 is available only if
 100 .B _BSD_SOURCE
 101 or
 102 .B _SVID_SOURCE
 103 is defined.
 104 .SH SEE ALSO
 105 .BR open (2),
 106 .BR closedir (3),
 107 .BR opendir (3),
 108 .BR readdir (3),
 109 .BR rewinddir (3),
 110 .BR scandir (3),
 111 .BR seekdir (3),
 112 .BR telldir (3)
 113 .SH COLOPHON
 114 This page is part of release 3.64 of the Linux
 115 .I man-pages
 116 project.
 117 A description of the project,
 118 and information about reporting bugs,
 119 can be found at
 120 \%http://www.kernel.org/doc/man\-pages/.