original/man3/telldir.3

   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  2013-09-02 "" "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 ATTRIBUTES
  65 .SS Multithreading (see pthreads(7))
  66 The
  67 .BR telldir ()
  68 function is thread-safe.
  69 .SH CONFORMING TO
  70 4.3BSD, POSIX.1-2001.
  71 .SH NOTES
  72 In glibc up to version 2.1.1, the return type of
  73 .BR telldir ()
  74 was
  75 .IR off_t .
  76 POSIX.1-2001 specifies
  77 .IR long ,
  78 and this is the type used since glibc 2.1.2.
  79
  80 In early filesystems, the value returned by
  81 .BR telldir ()
  82 was a simple file offset within a directory.
  83 Modern filesystems use tree or hash structures, rather than flat tables,
  84 to represent directories.
  85 On such filesystems, the value returned by
  86 .BR telldir ()
  87 (and used internally by
  88 .BR readdir (3))
  89 is a "cookie" that is used by the implementation
  90 to derive a position within a directory.
  91 .\" https://lwn.net/Articles/544298/
  92 Application programs should treat this strictly as an opaque value, making
  93 .I no
  94 assumptions about its contents.
  95 .SH SEE ALSO
  96 .BR closedir (3),
  97 .BR opendir (3),
  98 .BR readdir (3),
  99 .BR rewinddir (3),
 100 .BR scandir (3),
 101 .BR seekdir (3)
 102 .SH COLOPHON
 103 This page is part of release 3.67 of the Linux
 104 .I man-pages
 105 project.
 106 A description of the project,
 107 information about reporting bugs,
 108 and the latest version of this page,
 109 can be found at
 110 \%http://www.kernel.org/doc/man\-pages/.