share/man/man3c/fgetpos.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 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
  44 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH FGETPOS 3C "Jul 24, 2002"
  47 .SH NAME
  48 fgetpos \- get current file position information
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdio.h>
  53
  54 \fBint\fR \fBfgetpos\fR(\fBFILE *\fR\fIstream\fR, \fBfpos_t *\fR\fIpos\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBfgetpos()\fR function stores the current value of the file position
  61 indicator for the stream pointed to by \fIstream\fR in the object pointed to by
  62 \fIpos\fR. The value stored contains unspecified information usable by
  63 \fBfsetpos\fR(3C) for repositioning the stream to its position at the time of
  64 the call to \fBfgetpos()\fR.
  65 .SH RETURN VALUES
  66 .sp
  67 .LP
  68 Upon successful completion, \fBfgetpos()\fR returns \fB0\fR. Otherwise, it
  69 returns a non-zero value and sets \fBerrno\fR to indicate the error.
  70 .SH ERRORS
  71 .sp
  72 .LP
  73 The \fBfgetpos()\fR function may fail if:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBEBADF\fR\fR
  78 .ad
  79 .RS 13n
  80 The file descriptor underlying \fIstream\fR is not valid.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBESPIPE\fR\fR
  87 .ad
  88 .RS 13n
  89 The file descriptor underlying \fIstream\fR is associated with a pipe, a FIFO,
  90 or a socket.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBEOVERFLOW\fR\fR
  97 .ad
  98 .RS 13n
  99 The current value of the file position cannot be represented correctly in an
 100 object of type \fBfpos_t\fR.
 101 .RE
 102
 103 .SH ATTRIBUTES
 104 .sp
 105 .LP
 106 See \fBattributes\fR(5) for descriptions of the following attributes:
 107 .sp
 108
 109 .sp
 110 .TS
 111 box;
 112 c | c
 113 l | l .
 114 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 115 _
 116 Interface Stability     Standard
 117 .TE
 118
 119 .SH SEE ALSO
 120 .sp
 121 .LP
 122 \fBfopen\fR(3C), \fBfsetpos\fR(3C), \fBftell\fR(3C), \fBrewind\fR(3C),
 123 \fBungetc\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)