1 .\" Copyright (c) 1990, 1991 The Regents of the University of California.
2 .\" All rights reserved.
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.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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.
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
36 .\" @(#)fseek.3 6.11 (Berkeley) 6/29/91
38 .\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
40 .TH FSEEK 3 1993-11-29 "GNU" "Linux Programmer's Manual"
42 fgetpos, fseek, fsetpos, ftell, rewind \- reposition a stream
46 .BI "int fseek(FILE *" stream ", long " offset ", int " whence );
48 .BI "long ftell(FILE *" stream );
50 .BI "void rewind(FILE *" stream );
52 .BI "int fgetpos(FILE *" stream ", fpos_t *" pos );
54 .BI "int fsetpos(FILE *" stream ", fpos_t *" pos );
58 function sets the file position indicator for the stream pointed to by
60 The new position, measured in bytes, is obtained by adding
62 bytes to the position specified by
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
75 function clears the end-of-file indicator for the stream and undoes
78 function on the same stream.
82 function obtains the current value of the file position indicator for the
88 function sets the file position indicator for the stream pointed to by
90 to the beginning of the file.
94 (void) fseek(stream, 0L, SEEK_SET)
97 except that the error indicator for the stream is also cleared (see
104 functions are alternate interfaces equivalent to
110 setting and storing the current value of the file offset into or from the
113 On some non-Unix systems an
115 object may be a complex object and these routines may be the only way to
116 portably reposition a text stream.
120 function returns no value.
121 Upon successful completion,
128 returns the current offset.
129 Otherwise, \-1 is returned and
131 is set to indicate the error.
137 specified is not a seekable stream.
156 may also fail and set
158 for any of the errors specified for the routines