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

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2002, 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 FSETPOS 3C "Jul 24, 2002"
  11 .SH NAME
  12 fsetpos \- reposition a file pointer in a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17
  18 \fBint\fR \fBfsetpos\fR(\fBFILE *\fR\fIstream\fR, \fBconst fpos_t *\fR\fIpos\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBfsetpos()\fR function sets the file position indicator for the stream
  25 pointed to by \fIstream\fR according to the value of the object pointed to by
  26 \fIpos\fR, which must be a value obtained from an earlier call to
  27 \fBfgetpos\fR(3C) on the same stream.
  28 .sp
  29 .LP
  30 A successful call to \fBfsetpos()\fR function clears the end-of-file indicator
  31 for the stream and undoes any effects of \fBungetc\fR(3C) on the same stream.
  32 After an \fBfsetpos()\fR call, the next operation on an update stream may be
  33 either input or output.
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 The \fBfsetpos()\fR function returns \fB0\fR if it succeeds; otherwise it
  38 returns a non-zero value and sets \fBerrno\fR to indicate the error.
  39 .SH ERRORS
  40 .sp
  41 .LP
  42 The \fBfsetpos()\fR function may fail if:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBEBADF\fR\fR
  47 .ad
  48 .RS 10n
  49 The file descriptor underlying \fIstream\fR is not valid.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBESPIPE\fR\fR
  56 .ad
  57 .RS 10n
  58 The file descriptor underlying \fIstream\fR is associated with a pipe, a FIFO,
  59 or a socket.
  60 .RE
  61
  62 .SH USAGE
  63 .sp
  64 .LP
  65 The \fBfsetpos()\fR function has a transitional interface for 64-bit file
  66 offsets.  See \fBlf64\fR(5).
  67 .SH ATTRIBUTES
  68 .sp
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     Standard
  81 _
  82 MT-Level        MT-Safe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .sp
  87 .LP
  88 \fBlseek\fR(2), \fBfgetpos\fR(3C), \fBfopen\fR(3C), \fBfseek\fR(3C),
  89 \fBftell\fR(3C), \fBrewind\fR(3C), \fBungetc\fR(3C), \fBattributes\fR(5),
  90 \fBlf64\fR(5), \fBstandards\fR(5)