OSDN Git Service

(split) Import translated manuals from JM CVS Repository.
[linuxjm/LDP_man-pages.git] / original / man3 / telldir.3
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\"
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
6 .\"
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
11 .\"
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein.  The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
18 .\" professionally.
19 .\"
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
22 .\"
23 .\" References consulted:
24 .\"     Linux libc source code
25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
26 .\"     386BSD man pages
27 .\" Modified Sat Jul 24 17:48:42 1993 by Rik Faith (faith@cs.unc.edu)
28 .TH TELLDIR 3  2009-03-11 "" "Linux Programmer's Manual"
29 .SH NAME
30 telldir \- return current location in directory stream
31 .SH SYNOPSIS
32 .nf
33 .B #include <dirent.h>
34 .sp
35 .BI "long telldir(DIR *" dirp );
36 .fi
37 .sp
38 .in -4n
39 Feature Test Macro Requirements for glibc (see
40 .BR feature_test_macros (7)):
41 .in
42 .sp
43 .BR telldir ():
44 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE
45 .SH DESCRIPTION
46 The
47 .BR telldir ()
48 function returns the current location associated with
49 the directory stream \fIdirp\fP.
50 .SH "RETURN VALUE"
51 On success, the
52 .BR telldir ()
53 function returns the current location
54 in the directory stream.
55 On error, \-1 is returned, and
56 .I errno
57 is set appropriately.
58 .SH ERRORS
59 .TP
60 .B EBADF
61 Invalid directory stream descriptor \fIdirp\fP.
62 .SH "CONFORMING TO"
63 4.3BSD, POSIX.1-2001.
64 .SH NOTES
65 In glibc up to version 2.1.1, the return type of
66 .BR telldir ()
67 was
68 .IR off_t .
69 POSIX.1-2001 specifies
70 .IR long ,
71 and this is the type used since glibc 2.1.2.
72 .SH "SEE ALSO"
73 .BR closedir (3),
74 .BR opendir (3),
75 .BR readdir (3),
76 .BR rewinddir (3),
77 .BR scandir (3),
78 .BR seekdir (3)