share/man/man3c/ftell.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 FTELL 3C "Jul 24, 2002"
  47 .SH NAME
  48 ftell, ftello \- return a file offset in a stream
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdio.h>
  53
  54 \fBlong\fR \fBftell\fR(\fBFILE *\fR\fIstream\fR);
  55 .fi
  56
  57 .LP
  58 .nf
  59 \fBoff_t\fR \fBftello\fR(\fBFILE *\fR\fIstream\fR);
  60 .fi
  61
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 The \fBftell()\fR function obtains the current value of the file-position
  66 indicator for the stream pointed to by \fIstream\fR. The \fBftello()\fR
  67 function is identical to \fBftell()\fR except for the return type.
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 Upon successful completion, the \fBftell()\fR and \fBftello()\fR functions
  72 return the current value of the file-position indicator for the stream measured
  73 in bytes from the beginning of the file. Otherwise, they return \fB\(mi1\fR and
  74 sets \fBerrno\fR to indicate the error.
  75 .SH ERRORS
  76 .sp
  77 .LP
  78 The \fBftell()\fR and \fBftello()\fR functions will fail if:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBEBADF\fR\fR
  83 .ad
  84 .RS 10n
  85 The file descriptor underlying \fIstream\fR is not an open file descriptor.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBESPIPE\fR\fR
  92 .ad
  93 .RS 10n
  94 The file descriptor underlying \fIstream\fR is associated with a pipe, a FIFO,
  95 or a socket.
  96 .RE
  97
  98 .sp
  99 .LP
 100 The \fBftell()\fR function will fail if:
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBEOVERFLOW\fR\fR
 105 .ad
 106 .RS 13n
 107 The current file offset cannot be represented correctly in an object of type
 108 \fBlong\fR.
 109 .RE
 110
 111 .sp
 112 .LP
 113 The \fBftello()\fR function will fail if:
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBEOVERFLOW\fR\fR
 118 .ad
 119 .RS 13n
 120 The current file offset cannot be represented correctly in an object of type
 121 \fBoff_t\fR.
 122 .RE
 123
 124 .SH ATTRIBUTES
 125 .sp
 126 .LP
 127 See \fBattributes\fR(5) for descriptions of the following attributes:
 128 .sp
 129
 130 .sp
 131 .TS
 132 box;
 133 c | c
 134 l | l .
 135 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 136 _
 137 Interface Stability     Standard
 138 _
 139 MT-Level        MT-Safe
 140 .TE
 141
 142 .SH SEE ALSO
 143 .sp
 144 .LP
 145 \fBlseek\fR(2), \fBfopen\fR(3C), \fBfseek\fR(3C), \fBattributes\fR(5), ,
 146 \fBstandards\fR(5)