Name

telldir — return current location in directory stream

Synopsis

#include <dirent.h>
long telldir( DIR *dirp);
 
[Note] Note
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
telldir():
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE

DESCRIPTION

The telldir() function returns the current location associated with the directory stream dirp.

RETURN VALUE

On success, the telldir() function returns the current location in the directory stream. On error, −1 is returned, and errno is set appropriately.

ERRORS

EBADF

Invalid directory stream descriptor dirp.

CONFORMING TO

4.3BSD, POSIX.1-2001.

NOTES

In glibc up to version 2.1.1, the return type of telldir() was off_t. POSIX.1-2001 specifies long, and this is the type used since glibc 2.1.2.

In early file systems, the value returned by telldir() was a simple file offset within a directory. Modern file systems use tree or hash structures, rather than flat tables, to represent directories. On such file systems, the value returned by telldir() (and used internally by readdir(3)) is a "cookie" that is used by the implementation to derive a position within a directory. Application programs should treat this strictly as an opaque value, making no assumptions about its contents.

SEE ALSO

closedir(3), opendir(3), readdir(3), rewinddir(3), scandir(3), seekdir(3)

COLOPHON

This page is part of release 3.52 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man−pages/.


  Copyright 1993 David Metcalfe (davidprism.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 (faithcs.unc.edu)