]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (C) 2002 Andries Brouwer (aeb@cwi.nl) |
2 | .\" | |
93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
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. | |
c13182ef | 12 | .\" |
fea681da MK |
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. | |
c13182ef | 20 | .\" |
fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
22 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 23 | .\" %%%LICENSE_END |
fea681da | 24 | .\" |
fe0fefbf | 25 | .TH DIRFD 3 2015-03-02 "Linux" "Linux Programmer's Manual" |
fea681da MK |
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 | |
3e7a5293 | 33 | .BI "int dirfd(DIR *" dirp ); |
cc4615cc MK |
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 (): | |
f54c75ef MK |
41 | .br |
42 | .RS 4 | |
43 | .PD 0 | |
44 | .ad l | |
cc4615cc | 45 | _BSD_SOURCE || _SVID_SOURCE |
3ba63d80 MK |
46 | .br |
47 | || /* Since glibc 2.10: */ | |
48 | .RS 4 | |
49 | (_POSIX_C_SOURCE\ >=\ 200809L || _XOPEN_SOURCE\ >=\ 700) | |
50 | .RE | |
f54c75ef MK |
51 | .PD |
52 | .RE | |
53 | .ad | |
fea681da MK |
54 | .SH DESCRIPTION |
55 | The function | |
63aa9df0 | 56 | .BR dirfd () |
fea681da | 57 | returns the file descriptor associated with the directory stream |
3e7a5293 | 58 | .IR dirp . |
fea681da MK |
59 | .LP |
60 | This descriptor is the one used internally by the directory stream. | |
33a0ccb2 | 61 | As a result, it is useful only for functions which do not depend on |
fea681da MK |
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. | |
155a5e73 | 69 | .SH RETURN VALUE |
2fda57bd | 70 | On success, a nonnegative file descriptor is returned. |
7f1c12c5 MK |
71 | On error, \-1 is returned, and |
72 | .I errno | |
73 | is set to indicate the cause of the error. | |
fea681da | 74 | .SH ERRORS |
9f61bba1 | 75 | POSIX.1-2008 specifies two errors, |
155a5e73 MK |
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. | |
70d8c4cb | 87 | .SH ATTRIBUTES |
b21d33ae MK |
88 | For an explanation of the terms used in this section, see |
89 | .BR attributes (7). | |
90 | .TS | |
91 | allbox; | |
92 | lb lb lb | |
93 | l l l. | |
94 | Interface Attribute Value | |
95 | T{ | |
70d8c4cb | 96 | .BR dirfd () |
b21d33ae MK |
97 | T} Thread safety MT-Safe |
98 | .TE | |
47297adb | 99 | .SH CONFORMING TO |
9f61bba1 MK |
100 | POSIX.1-2008. |
101 | This function was a BSD extension, present in 4.3BSD-Reno, not in 4.2BSD. | |
102 | .\" It is present in libc5 (since 5.1.2) and in glibc2. | |
fea681da MK |
103 | .SH NOTES |
104 | The prototype for | |
e511ffb6 | 105 | .BR dirfd () |
33a0ccb2 | 106 | is available only if |
fea681da MK |
107 | .B _BSD_SOURCE |
108 | or | |
109 | .B _SVID_SOURCE | |
fb961f31 | 110 | is defined. |
47297adb | 111 | .SH SEE ALSO |
fea681da MK |
112 | .BR open (2), |
113 | .BR closedir (3), | |
114 | .BR opendir (3), | |
115 | .BR readdir (3), | |
116 | .BR rewinddir (3), | |
117 | .BR scandir (3), | |
118 | .BR seekdir (3), | |
119 | .BR telldir (3) |