]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) |
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 MK |
24 | .\" |
25 | .\" References consulted: | |
26 | .\" Linux libc source code | |
27 | .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) | |
28 | .\" 386BSD man pages | |
29 | .\" Modified Sat Jul 24 17:48:42 1993 by Rik Faith (faith@cs.unc.edu) | |
460495ca | 30 | .TH TELLDIR 3 2015-08-08 "" "Linux Programmer's Manual" |
fea681da MK |
31 | .SH NAME |
32 | telldir \- return current location in directory stream | |
33 | .SH SYNOPSIS | |
34 | .nf | |
35 | .B #include <dirent.h> | |
36 | .sp | |
48e39fa7 | 37 | .BI "long telldir(DIR *" dirp ); |
fea681da | 38 | .fi |
cc4615cc MK |
39 | .sp |
40 | .in -4n | |
41 | Feature Test Macro Requirements for glibc (see | |
42 | .BR feature_test_macros (7)): | |
43 | .in | |
44 | .sp | |
45 | .BR telldir (): | |
46 | _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE | |
fea681da | 47 | .SH DESCRIPTION |
60a90ecd MK |
48 | The |
49 | .BR telldir () | |
50 | function returns the current location associated with | |
6dea120e | 51 | the directory stream \fIdirp\fP. |
47297adb | 52 | .SH RETURN VALUE |
60a90ecd MK |
53 | On success, the |
54 | .BR telldir () | |
55 | function returns the current location | |
cca657e2 MK |
56 | in the directory stream. |
57 | On error, \-1 is returned, and | |
58 | .I errno | |
59 | is set appropriately. | |
fea681da MK |
60 | .SH ERRORS |
61 | .TP | |
62 | .B EBADF | |
6dea120e | 63 | Invalid directory stream descriptor \fIdirp\fP. |
f7dbb1ea | 64 | .SH ATTRIBUTES |
a257b544 PH |
65 | For an explanation of the terms used in this section, see |
66 | .BR attributes (7). | |
67 | .TS | |
68 | allbox; | |
69 | lb lb lb | |
70 | l l l. | |
71 | Interface Attribute Value | |
72 | T{ | |
f7dbb1ea | 73 | .BR telldir () |
a257b544 PH |
74 | T} Thread safety MT-Safe |
75 | .TE | |
47297adb | 76 | .SH CONFORMING TO |
12c3c485 | 77 | POSIX.1-2001, POSIX.1-2008, 4.3BSD. |
48e39fa7 MK |
78 | .SH NOTES |
79 | In glibc up to version 2.1.1, the return type of | |
80 | .BR telldir () | |
81 | was | |
82 | .IR off_t . | |
83 | POSIX.1-2001 specifies | |
84 | .IR long , | |
85 | and this is the type used since glibc 2.1.2. | |
73f4bf1e | 86 | |
9ee4a2b6 | 87 | In early filesystems, the value returned by |
73f4bf1e MK |
88 | .BR telldir () |
89 | was a simple file offset within a directory. | |
9ee4a2b6 | 90 | Modern filesystems use tree or hash structures, rather than flat tables, |
73f4bf1e | 91 | to represent directories. |
9ee4a2b6 | 92 | On such filesystems, the value returned by |
73f4bf1e MK |
93 | .BR telldir () |
94 | (and used internally by | |
95 | .BR readdir (3)) | |
96 | is a "cookie" that is used by the implementation | |
97 | to derive a position within a directory. | |
98 | .\" https://lwn.net/Articles/544298/ | |
99 | Application programs should treat this strictly as an opaque value, making | |
100 | .I no | |
101 | assumptions about its contents. | |
47297adb | 102 | .SH SEE ALSO |
fea681da MK |
103 | .BR closedir (3), |
104 | .BR opendir (3), | |
105 | .BR readdir (3), | |
106 | .BR rewinddir (3), | |
107 | .BR scandir (3), | |
108 | .BR seekdir (3) |