projects / thirdparty / man-pages.git / blame
| 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) | |
| 48e39fa7 | 30 | .TH TELLDIR 3 2009-03-11 "" "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. |
| 47297adb | 64 | .SH CONFORMING TO |
| 68e1685c | 65 | 4.3BSD, POSIX.1-2001. |
| 48e39fa7 MK |
66 | .SH NOTES |
| 67 | In glibc up to version 2.1.1, the return type of | |
| 68 | .BR telldir () | |
| 69 | was | |
| 70 | .IR off_t . | |
| 71 | POSIX.1-2001 specifies | |
| 72 | .IR long , | |
| 73 | and this is the type used since glibc 2.1.2. | |
| 47297adb | 74 | .SH SEE ALSO |
| fea681da MK |
75 | .BR closedir (3), |
| 76 | .BR opendir (3), | |
| 77 | .BR readdir (3), | |
| 78 | .BR rewinddir (3), | |
| 79 | .BR scandir (3), | |
| 80 | .BR seekdir (3) |