summaryrefslogtreecommitdiff
path: root/man3/dirfd.3
blob: bda8211342d1cb6832504f542fb29d6a67449f8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.\" Copyright (C) 2002 Andries Brouwer (aeb@cwi.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.
.\"
.TH DIRFD 3 2007-07-26 "Linux" "Linux Programmer's Manual"
.SH NAME
dirfd \- get directory stream file descriptor
.SH SYNOPSIS
.B #include <sys/types.h>
.br
.B #include <dirent.h>
.sp
.BI "int dirfd(DIR *" dir );
.sp
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.sp
.BR dirfd ():
_BSD_SOURCE || _SVID_SOURCE
.SH DESCRIPTION
The function
.BR dirfd ()
returns the file descriptor associated with the directory stream
.IR dir .
.LP
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
.BR fstat (2)
and
.BR fchdir (2).
It will be automatically closed when
.BR closedir (3)
is called.
.SH ERRORS
On error \-1 is returned.
.SH "CONFORMING TO"
This is a BSD extension, present in 4.3BSD-Reno, not in 4.2BSD.
It is present in libc5 (since 5.1.2) and in glibc2.
.\" As at 2006:
This function is under consideration for inclusion in
a future version of POSIX.1.
.SH NOTES
The prototype for
.BR dirfd ()
is only available if
.B _BSD_SOURCE
or
.B _SVID_SOURCE
is defined.
.SH "SEE ALSO"
.BR open (2),
.BR closedir (3),
.BR opendir (3),
.BR readdir (3),
.BR rewinddir (3),
.BR scandir (3),
.BR seekdir (3),
.BR telldir (3)