[thirdparty/man-pages.git] / man3 / telldir.3

.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" 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.
.\" %%%LICENSE_END
.\"
.\" References consulted:
.\"     Linux libc source code
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
.\"     386BSD man pages
.\" Modified Sat Jul 24 17:48:42 1993 by Rik Faith (faith@cs.unc.edu)
.TH TELLDIR 3  2009-03-11 "" "Linux Programmer's Manual"
.SH NAME
telldir \- return current location in directory stream
.SH SYNOPSIS
.nf
.B #include <dirent.h>
.sp
.BI "long telldir(DIR *" dirp );
.fi
.sp
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.sp
.BR telldir ():
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE
.SH DESCRIPTION
The
.BR telldir ()
function returns the current location associated with
the directory stream \fIdirp\fP.
.SH RETURN VALUE
On success, the
.BR telldir ()
function returns the current location
in the directory stream.
On error, \-1 is returned, and
.I errno
is set appropriately.
.SH ERRORS
.TP
.B EBADF
Invalid directory stream descriptor \fIdirp\fP.
.SH CONFORMING TO
4.3BSD, POSIX.1-2001.
.SH NOTES
In glibc up to version 2.1.1, the return type of
.BR telldir ()
was
.IR off_t .
POSIX.1-2001 specifies
.IR long ,
and this is the type used since glibc 2.1.2.
.SH SEE ALSO
.BR closedir (3),
.BR opendir (3),
.BR readdir (3),
.BR rewinddir (3),
.BR scandir (3),
.BR seekdir (3)
Commit	Line	Data
	1	.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
	2	.\"
	3	.\" %%%LICENSE_START(VERBATIM)
	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.
	12	.\"
	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.
	20	.\"
	21	.\" Formatted or processed versions of this manual, if unaccompanied by
	22	.\" the source, must acknowledge the copyright and authors of this work.
	23	.\" %%%LICENSE_END
	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)
	30	.TH TELLDIR 3 2009-03-11 "" "Linux Programmer's Manual"
	31	.SH NAME
	32	telldir \- return current location in directory stream
	33	.SH SYNOPSIS
	34	.nf
	35	.B #include <dirent.h>
	36	.sp
	37	.BI "long telldir(DIR *" dirp );
	38	.fi
	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
	47	.SH DESCRIPTION
	48	The
	49	.BR telldir ()
	50	function returns the current location associated with
	51	the directory stream \fIdirp\fP.
	52	.SH RETURN VALUE
	53	On success, the
	54	.BR telldir ()
	55	function returns the current location
	56	in the directory stream.
	57	On error, \-1 is returned, and
	58	.I errno
	59	is set appropriately.
	60	.SH ERRORS
	61	.TP
	62	.B EBADF
	63	Invalid directory stream descriptor \fIdirp\fP.
	64	.SH CONFORMING TO
	65	4.3BSD, POSIX.1-2001.
	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.
	74	.SH SEE ALSO
	75	.BR closedir (3),
	76	.BR opendir (3),
	77	.BR readdir (3),
	78	.BR rewinddir (3),
	79	.BR scandir (3),
	80	.BR seekdir (3)