share/man/man3c/fsetpos.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  45 .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH FSETPOS 3C "Jul 24, 2002"
  48 .SH NAME
  49 fsetpos \- reposition a file pointer in a stream
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <stdio.h>
  54
  55 \fBint\fR \fBfsetpos\fR(\fBFILE *\fR\fIstream\fR, \fBconst fpos_t *\fR\fIpos\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBfsetpos()\fR function sets the file position indicator for the stream
  62 pointed to by \fIstream\fR according to the value of the object pointed to by
  63 \fIpos\fR, which must be a value obtained from an earlier call to
  64 \fBfgetpos\fR(3C) on the same stream.
  65 .sp
  66 .LP
  67 A successful call to \fBfsetpos()\fR function clears the end-of-file indicator
  68 for the stream and undoes any effects of \fBungetc\fR(3C) on the same stream.
  69 After an \fBfsetpos()\fR call, the next operation on an update stream may be
  70 either input or output.
  71 .SH RETURN VALUES
  72 .sp
  73 .LP
  74 The \fBfsetpos()\fR function returns \fB0\fR if it succeeds; otherwise it
  75 returns a non-zero value and sets \fBerrno\fR to indicate the error.
  76 .SH ERRORS
  77 .sp
  78 .LP
  79 The \fBfsetpos()\fR function may fail if:
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBEBADF\fR\fR
  84 .ad
  85 .RS 10n
  86 The file descriptor underlying \fIstream\fR is not valid.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBESPIPE\fR\fR
  93 .ad
  94 .RS 10n
  95 The file descriptor underlying \fIstream\fR is associated with a pipe, a FIFO,
  96 or a socket.
  97 .RE
  98
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 Interface Stability     Standard
 113 _
 114 MT-Level        MT-Safe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBlseek\fR(2), \fBfgetpos\fR(3C), \fBfopen\fR(3C), \fBfseek\fR(3C),
 121 \fBftell\fR(3C), \fBrewind\fR(3C), \fBungetc\fR(3C), \fBattributes\fR(5),
 122 \fBstandards\fR(5)