share/man/man3c/telldir.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  44 .\" Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH TELLDIR 3C "Aug 14, 2002"
  47 .SH NAME
  48 telldir \- current location of a named directory stream
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <dirent.h>
  53
  54 \fBlong int\fR \fBtelldir\fR(\fBDIR *\fR\fIdirp\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBtelldir()\fR function obtains the current location associated with the
  61 directory stream specified by \fIdirp\fR.
  62 .sp
  63 .LP
  64 If the most recent operation on the directory stream was a \fBseekdir\fR(3C),
  65 the directory position returned from the \fBtelldir()\fR is the same as that
  66 supplied as a \fIloc\fR argument for \fBseekdir()\fR.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 Upon successful completion, \fBtelldir()\fR returns the current location of the
  71 specified directory stream.
  72 .SH ERRORS
  73 .sp
  74 .LP
  75 The \fBtelldir()\fR function will fail if:
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBEOVERFLOW\fR\fR
  80 .ad
  81 .RS 13n
  82 The current location of the directory cannot be stored in an object of type
  83 \fBlong\fR.
  84 .RE
  85
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard
 100 _
 101 MT-Level        Safe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBopendir\fR(3C), \fBreaddir\fR(3C), \fBseekdir\fR(3C), \fBattributes\fR(5),
 108 \fBstandards\fR(5)