summaryrefslogtreecommitdiff
path: root/reference/C/MAN/fgetpos.htm
blob: dd76134ab56b73e3a985e75677275f17ecf711a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<TITLE>fgetpos</TITLE>
<body bgcolor="#ffffcc">
<hr>
<pre>



<h3>FSEEK(3)            Linux Programmer's Manual            FSEEK(3)
</h3>

<h3>NAME
</h3>       fgetpos,  fseek,  fsetpos,  ftell,  rewind  - reposition a
       stream

<h3>SYNOPSIS
</h3>       #include &lt;stdio.h&gt;

       int fseek( FILE *stream, long offset, int whence);
       long ftell( FILE *stream);
       void rewind( FILE *stream);
       int fgetpos( FILE *stream, fpos_t *pos);
       int fsetpos( FILE *stream, fpos_t *pos);

<h3>DESCRIPTION
</h3>       The fseek function sets the file  position  indicator  for
       the  stream  pointed to by stream.  The new position, mea-
       sured in bytes, is obtained by adding offset bytes to  the
       position  specified  by  whence.   If  whence  is  set  to
       SEEK_SET, SEEK_CUR, or SEEK_END, the offset is relative to
       the  start of the file, the current position indicator, or
       end-of-file, respectively.  A successful call to the fseek
       function  clears  the end-of-file indicator for the stream
       and undoes any effects of the ungetc(3)  function  on  the
       same stream.

       The  ftell  function obtains the current value of the file
       position indicator for the stream pointed to by stream.

       The rewind function sets the file position  indicator  for
       the  stream  pointed  to by stream to the beginning of the
       file.  It is equivalent to:

              (void)fseek(stream, 0L, SEEK_SET)

       except that the error indicator for  the  stream  is  also
       cleared (see clearerr(3).

       The fgetpos and fsetpos functions are alternate interfaces
       equivalent  to  ftell  and  fseek  (with  whence  set   to
       SEEK_SET),  setting  and  storing the current value of the
       file offset into or from the object referenced by pos.  On
       some  non-UNIX  systems  an fpos_t object may be a complex
       object and these routines may be the only way to  portably
       reposition a text stream.

<h3>RETURN VALUES
</h3>       The  rewind  function  returns  no value.  Upon successful
       completion, fgetpos, fseek, fsetpos return  0,  and  ftell
       returns the current offset.  Otherwise, -1 is returned and
       the global variable errno is set to indicate the error.

<h3>ERRORS
</h3>       EBADF  The stream specified is not a seekable stream.




<h3>BSD MANPAGE              29 November 1993                       1
</h3>




<h3>FSEEK(3)            Linux Programmer's Manual            FSEEK(3)
</h3>

       EINVAL The whence argument  to  fseek  was  not  SEEK_SET,
              SEEK_END, or SEEK_CUR.

       The  function  fgetpos, fseek, fsetpos, and ftell may also
       fail and set errno for any of the errors specified for the
       routines fflush(3), fstat(2), lseek(2), and malloc(3).

</pre>
<hr>
<h3>SEE ALSO
</h3><p>
<a href=lseek.htm>lseek</a>, 
<pre>

<h3>STANDARDS
</h3>       The  fgetpos,  fsetpos, fseek, ftell, and rewind functions
       conform to ANSI C3.159-1989 (``ANSI C'').












































<h3>BSD MANPAGE              29 November 1993                       2
</h3>


</pre>
<P>
<hr>
<p>
<center>
<table border=2 width=80%>
<tr align=center>
<td width=25%>
<a href=../cref.html>Top</a>
</td><td width=25%>
<a href=../master_index.html>Master Index</a>
</td><td width=25%>
<a href=../SYNTAX/keywords.html>Keywords</a>
</td><td width=25%>
<a href=../FUNCTIONS/funcref.htm>Functions</a>
</td>
</tr>
</table>
</center>
<p>
<hr>

This manual page was brought to you by <i>mjl_man V-2.0</i>