usr/src/man/man3c/seekdir.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) 2002, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH SEEKDIR 3C "Aug 14, 2002"
  47 .SH NAME
  48 seekdir \- set position of directory stream
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <sys/types.h>
  53 #include <dirent.h>
  54
  55 \fBvoid\fR \fBseekdir\fR(\fBDIR *\fR\fIdirp\fR, \fBlong int\fR \fIloc\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBseekdir()\fR function sets the position of the next \fBreaddir\fR(3C)
  62 operation on the directory stream specified by \fIdirp\fR to the position
  63 specified by \fIloc\fR. The value of \fIloc\fR should have been returned from
  64 an earlier call to \fBtelldir\fR(3C). The new position reverts to the one
  65 associated with the directory stream when \fBtelldir()\fR was performed.
  66 .sp
  67 .LP
  68 If the value of \fIloc\fR was not obtained from an earlier call to
  69 \fBtelldir()\fR or if a call to \fBrewinddir\fR(3C) occurred between the call
  70 to \fBtelldir()\fR and the call to \fBseekdir()\fR, the results of
  71 subsequent calls to \fBreaddir()\fR are unspecified.
  72 .SH RETURN VALUES
  73 .sp
  74 .LP
  75 The \fBseekdir()\fR function returns no value.
  76 .SH ERRORS
  77 .sp
  78 .LP
  79 No errors are defined.
  80 .SH ATTRIBUTES
  81 .sp
  82 .LP
  83 See \fBattributes\fR(5) for descriptions of the following attributes:
  84 .sp
  85
  86 .sp
  87 .TS
  88 box;
  89 c | c
  90 l | l .
  91 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  92 _
  93 Interface Stability     Standard
  94 _
  95 MT-Level        Safe
  96 .TE
  97
  98 .SH SEE ALSO
  99 .sp
 100 .LP
 101 \fBopendir\fR(3C), \fBreaddir\fR(3C), \fBrewinddir\fR(3C), \fBtelldir\fR(3C),
 102 \fBattributes\fR(5), \fBstandards\fR(5)