usr/src/man/man3c/fseek.3c

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 20023, Sun Microsystems, Inc.  All Rights Reserved.  Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH FSEEK 3C "Nov 1, 2003"
  11 .SH NAME
  12 fseek, fseeko \- reposition a file-position indicator in a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17
  18 \fBint\fR \fBfseek\fR(\fBFILE *\fR\fIstream\fR, \fBlong\fR \fIoffset\fR, \fBint\fR \fIwhence\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBfseeko\fR(\fBFILE *\fR\fIstream\fR, \fBoff_t\fR \fIoffset\fR, \fBint\fR \fIwhence\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBfseek()\fR function sets the file-position indicator for the stream
  30 pointed to by \fIstream\fR. The \fBfseeko()\fR function is identical to
  31 \fBfseek()\fR except for the type of \fIoffset\fR.
  32 .sp
  33 .LP
  34 The new position, measured in bytes from the beginning of the file, is obtained
  35 by adding \fIoffset\fR to the position specified by \fIwhence\fR, whose values
  36 are defined in <\fBstdio.h\fR> as follows:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBSEEK_SET\fR\fR
  41 .ad
  42 .RS 12n
  43 Set position equal to \fIoffset\fR bytes.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBSEEK_CUR\fR\fR
  50 .ad
  51 .RS 12n
  52 Set position to current location plus \fIoffset\fR.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBSEEK_END\fR\fR
  59 .ad
  60 .RS 12n
  61 Set position to \fBEOF\fR plus \fIoffset\fR.
  62 .RE
  63
  64 .sp
  65 .LP
  66 If the stream is to be used with wide character input/output functions,
  67 \fIoffset\fR must either be 0 or a value returned by an earlier call to
  68 \fBftell\fR(3C) on the same stream and \fIwhence\fR must be \fBSEEK_SET\fR.
  69 .sp
  70 .LP
  71 A successful call to \fBfseek()\fR clears the end-of-file indicator for the
  72 stream and undoes any effects of \fBungetc\fR(3C) and \fBungetwc\fR(3C) on the
  73 same stream.  After an \fBfseek()\fR call, the next operation on an update
  74 stream may be either input or output.
  75 .sp
  76 .LP
  77 If the most recent operation, other than \fBftell\fR(3C), on a given stream is
  78 \fBfflush\fR(3C), the file offset in the underlying open file description will
  79 be adjusted to reflect the location specified by \fBfseek()\fR.
  80 .sp
  81 .LP
  82 The \fBfseek()\fR function allows the file-position indicator to be set beyond
  83 the end of existing data in the file. If data is later written at this point,
  84 subsequent reads of data in the gap will return bytes with the value 0 until
  85 data is actually written into the gap.
  86 .sp
  87 .LP
  88 The value of the file offset returned by \fBfseek()\fR on devices which are
  89 incapable of seeking is undefined.
  90 .sp
  91 .LP
  92 If the stream is writable and buffered data had not been written to the
  93 underlying file, \fBfseek()\fR will cause the unwritten data to be written to
  94 the file and mark the \fBst_ctime\fR and \fBst_mtime\fR fields of the file for
  95 update.
  96 .SH RETURN VALUES
  97 .sp
  98 .LP
  99 The \fBfseek()\fR and \fBfseeko()\fR functions return \fB0\fR on success;
 100 otherwise, they returned \fB\(mi1\fR and set \fBerrno\fR to indicate the error.
 101 .SH ERRORS
 102 .sp
 103 .LP
 104 The \fBfseek()\fR and \fBfseeko()\fR functions will fail if, either the
 105 \fIstream\fR is unbuffered or the \fIstream\fR's buffer needed to be flushed,
 106 and the call to \fBfseek()\fR or \fBfseeko()\fR causes an underlying
 107 \fBlseek\fR(2) or \fBwrite\fR(2) to be invoked:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBEAGAIN\fR\fR
 112 .ad
 113 .RS 10n
 114 The \fBO_NONBLOCK\fR flag is set for the file descriptor and the process would
 115 be delayed in the write operation.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBEBADF\fR\fR
 122 .ad
 123 .RS 10n
 124 The file descriptor underlying the stream file is not open for writing or the
 125 stream's buffer needed to be flushed and the file is not open.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBEFBIG\fR\fR
 132 .ad
 133 .RS 10n
 134 An attempt was made to write a file that exceeds the maximum file size or the
 135 process's file size limit, or the file is a regular file and an attempt was
 136 made to write at or beyond the offset maximum associated with the corresponding
 137 stream.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBEINTR\fR\fR
 144 .ad
 145 .RS 10n
 146 The write operation was terminated due to the receipt of a signal, and no data
 147 was transferred.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBEINVAL\fR\fR
 154 .ad
 155 .RS 10n
 156 The \fIwhence\fR argument is invalid. The resulting file-position indicator
 157 would be set to a negative value.
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fBEIO\fR\fR
 164 .ad
 165 .RS 10n
 166 A physical I/O error has occurred; or the process is a member of a background
 167 process group attempting to perform a \fBwrite\fR(2) operation to its
 168 controlling terminal, \fBTOSTOP\fR is set, the process is neither ignoring nor
 169 blocking \fBSIGTTOU\fR, and the process group of the process is orphaned.
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fBENOSPC\fR\fR
 176 .ad
 177 .RS 10n
 178 There was no free space remaining on the device containing the file.
 179 .RE
 180
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fBENXIO\fR\fR
 185 .ad
 186 .RS 10n
 187 A request was made of a non-existent device, or the request was outside the
 188 capabilities of the device.
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fBEPIPE\fR\fR
 195 .ad
 196 .RS 10n
 197 The file descriptor underlying \fIstream\fR is associated with a pipe or FIFO.
 198 .RE
 199
 200 .sp
 201 .ne 2
 202 .na
 203 \fB\fBEPIPE\fR\fR
 204 .ad
 205 .RS 10n
 206 An attempt was made to write to a pipe or \fBFIFO\fR that is not open for
 207 reading by any process. A \fBSIGPIPE\fR signal will also be sent to the calling
 208 thread.
 209 .RE
 210
 211 .sp
 212 .LP
 213 The \fBfseek()\fR function will fail if:
 214 .sp
 215 .ne 2
 216 .na
 217 \fB\fBEOVERFLOW\fR\fR
 218 .ad
 219 .RS 13n
 220 The resulting file offset would be a value which cannot be represented
 221 correctly in an object of type \fBlong\fR.
 222 .RE
 223
 224 .sp
 225 .LP
 226 The \fBfseeko()\fR function will fail if:
 227 .sp
 228 .ne 2
 229 .na
 230 \fB\fBEOVERFLOW\fR\fR
 231 .ad
 232 .RS 13n
 233 The resulting file offset would be a value which cannot be represented
 234 correctly in an object of type \fBoff_t\fR.
 235 .RE
 236
 237 .SH USAGE
 238 .sp
 239 .LP
 240 Although on the UNIX system an offset returned by \fBftell()\fR or
 241 \fBftello()\fR (see \fBftell\fR(3C)) is measured in bytes, and it is
 242 permissible to seek to positions relative to that offset, portability to
 243 non-UNIX systems requires that an offset be used by \fBfseek()\fR directly.
 244 Arithmetic may not meaningfully be performed on such an offset, which is not
 245 necessarily measured in bytes.
 246 .sp
 247 .LP
 248 The \fBfseeko()\fR function has a transitional interface for 64-bit file
 249 offsets.  See \fBlf64\fR(5).
 250 .SH ATTRIBUTES
 251 .sp
 252 .LP
 253 See \fBattributes\fR(5) for descriptions of the following attributes:
 254 .sp
 255
 256 .sp
 257 .TS
 258 box;
 259 c | c
 260 l | l .
 261 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 262 _
 263 Interface Stability     Standard
 264 _
 265 MT-Level        MT-Safe
 266 .TE
 267
 268 .SH SEE ALSO
 269 .sp
 270 .LP
 271 \fBgetrlimit\fR(2), \fBulimit\fR(2), \fBfopen\fR(3UCB), \fBftell\fR(3C),
 272 \fBrewind\fR(3C), \fBungetc\fR(3C), \fBungetwc\fR(3C), \fBattributes\fR(5),
 273 \fBlf64\fR(5), \fBstandards\fR(5)