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  2021-03-22 "" "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 .PP
  37 .BI "long telldir(DIR *" dirp );
  38 .fi
  39 .PP
  40 .RS -4
  41 Feature Test Macro Requirements for glibc (see
  42 .BR feature_test_macros (7)):
  43 .RE
  44 .PP
  45 .BR telldir ():
  46 .nf
  47     _XOPEN_SOURCE
  48        || /* Glibc since 2.19: */ _DEFAULT_SOURCE
  49        || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  50 .fi
  51 .SH DESCRIPTION
  52 The
  53 .BR telldir ()
  54 function returns the current location associated with
  55 the directory stream \fIdirp\fP.
  56 .SH RETURN VALUE
  57 On success, the
  58 .BR telldir ()
  59 function returns the current location
  60 in the directory stream.
  61 On error, \-1 is returned, and
  62 .I errno
  63 is set to indicate the error.
  64 .SH ERRORS
  65 .TP
  66 .B EBADF
  67 Invalid directory stream descriptor \fIdirp\fP.
  68 .SH ATTRIBUTES
  69 For an explanation of the terms used in this section, see
  70 .BR attributes (7).
  71 .ad l
  72 .nh
  73 .TS
  74 allbox;
  75 lbx lb lb
  76 l l l.
  77 Interface       Attribute       Value
  78 T{
  79 .BR telldir ()
  80 T}      Thread safety   MT-Safe
  81 .TE
  82 .hy
  83 .ad
  84 .sp 1
  85 .SH CONFORMING TO
  86 POSIX.1-2001, POSIX.1-2008, 4.3BSD.
  87 .SH NOTES
  88 In glibc up to version 2.1.1, the return type of
  89 .BR telldir ()
  90 was
  91 .IR off_t .
  92 POSIX.1-2001 specifies
  93 .IR long ,
  94 and this is the type used since glibc 2.1.2.
  95 .PP
  96 In early filesystems, the value returned by
  97 .BR telldir ()
  98 was a simple file offset within a directory.
  99 Modern filesystems use tree or hash structures, rather than flat tables,
 100 to represent directories.
 101 On such filesystems, the value returned by
 102 .BR telldir ()
 103 (and used internally by
 104 .BR readdir (3))
 105 is a "cookie" that is used by the implementation
 106 to derive a position within a directory.
 107 .\" https://lwn.net/Articles/544298/
 108 Application programs should treat this strictly as an opaque value, making
 109 .I no
 110 assumptions about its contents.
 111 .SH SEE ALSO
 112 .BR closedir (3),
 113 .BR opendir (3),
 114 .BR readdir (3),
 115 .BR rewinddir (3),
 116 .BR scandir (3),
 117 .BR seekdir (3)