original/man3/fseek.3

   1 .\" Copyright (c) 1990, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)fseek.3     6.11 (Berkeley) 6/29/91
  37 .\"
  38 .\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
  39 .\"
  40 .TH FSEEK 3  1993-11-29 "GNU" "Linux Programmer's Manual"
  41 .SH NAME
  42 fgetpos, fseek, fsetpos, ftell, rewind \- reposition a stream
  43 .SH SYNOPSIS
  44 .B #include <stdio.h>
  45 .sp
  46 .BI "int fseek(FILE *" stream ", long " offset ", int " whence );
  47
  48 .BI "long ftell(FILE *" stream );
  49
  50 .BI "void rewind(FILE *" stream );
  51
  52 .BI "int fgetpos(FILE *" stream ", fpos_t *" pos );
  53 .br
  54 .BI "int fsetpos(FILE *" stream ", fpos_t *" pos );
  55 .SH DESCRIPTION
  56 The
  57 .BR fseek ()
  58 function sets the file position indicator for the stream pointed to by
  59 .IR stream .
  60 The new position, measured in bytes, is obtained by adding
  61 .I offset
  62 bytes to the position specified by
  63 .IR whence .
  64 If
  65 .I whence
  66 is set to
  67 .BR SEEK_SET ,
  68 .BR SEEK_CUR ,
  69 or
  70 .BR SEEK_END ,
  71 the offset is relative to the start of the file, the current position
  72 indicator, or end-of-file, respectively.
  73 A successful call to the
  74 .BR fseek ()
  75 function clears the end-of-file indicator for the stream and undoes
  76 any effects of the
  77 .BR ungetc (3)
  78 function on the same stream.
  79 .PP
  80 The
  81 .BR ftell ()
  82 function obtains the current value of the file position indicator for the
  83 stream pointed to by
  84 .IR stream .
  85 .PP
  86 The
  87 .BR rewind ()
  88 function sets the file position indicator for the stream pointed to by
  89 .I stream
  90 to the beginning of the file.
  91 It is equivalent to:
  92 .PP
  93 .RS
  94 (void) fseek(stream, 0L, SEEK_SET)
  95 .RE
  96 .PP
  97 except that the error indicator for the stream is also cleared (see
  98 .BR clearerr (3)).
  99 .PP
 100 The
 101 .BR fgetpos ()
 102 and
 103 .BR fsetpos ()
 104 functions are alternate interfaces equivalent to
 105 .BR ftell ()
 106 and
 107 .BR fseek ()
 108 (with whence set to
 109 .BR SEEK_SET ),
 110 setting and storing the current value of the file offset into or from the
 111 object referenced by
 112 .IR pos .
 113 On some non-UNIX systems an
 114 .I fpos_t
 115 object may be a complex object and these routines may be the only way to
 116 portably reposition a text stream.
 117 .SH "RETURN VALUE"
 118 The
 119 .BR rewind ()
 120 function returns no value.
 121 Upon successful completion,
 122 .BR fgetpos (),
 123 .BR fseek (),
 124 .BR fsetpos ()
 125 return 0,
 126 and
 127 .BR ftell ()
 128 returns the current offset.
 129 Otherwise, \-1 is returned and
 130 .I errno
 131 is set to indicate the error.
 132 .SH ERRORS
 133 .TP
 134 .B EBADF
 135 The
 136 .I stream
 137 specified is not a seekable stream.
 138 .TP
 139 .B EINVAL
 140 The
 141 .I whence
 142 argument to
 143 .BR fseek ()
 144 was not
 145 .BR SEEK_SET ,
 146 .BR SEEK_END ,
 147 or
 148 .BR SEEK_CUR .
 149 .PP
 150 The functions
 151 .BR fgetpos (),
 152 .BR fseek (),
 153 .BR fsetpos (),
 154 and
 155 .BR ftell ()
 156 may also fail and set
 157 .I errno
 158 for any of the errors specified for the routines
 159 .BR fflush (3),
 160 .BR fstat (2),
 161 .BR lseek (2),
 162 and
 163 .BR malloc (3).
 164 .SH "CONFORMING TO"
 165 C89, C99.
 166 .SH "SEE ALSO"
 167 .BR lseek (2),
 168 .BR fseeko (3)