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

   1 '\" te
   2 .\"  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 FTELL 3C "Jul 24, 2002"
  11 .SH NAME
  12 ftell, ftello \- return a file offset in a stream
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17
  18 \fBlong\fR \fBftell\fR(\fBFILE *\fR\fIstream\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBoff_t\fR \fBftello\fR(\fBFILE *\fR\fIstream\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBftell()\fR function obtains the current value of the file-position
  30 indicator for the stream pointed to by \fIstream\fR. The \fBftello()\fR
  31 function is identical to \fBftell()\fR except for the return type.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 Upon successful completion, the \fBftell()\fR and \fBftello()\fR functions
  36 return the current value of the file-position indicator for the stream measured
  37 in bytes from the beginning of the file. Otherwise, they return \fB\(mi1\fR and
  38 sets \fBerrno\fR to indicate the error.
  39 .SH ERRORS
  40 .sp
  41 .LP
  42 The \fBftell()\fR and \fBftello()\fR functions will 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 an open file descriptor.
  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 .sp
  63 .LP
  64 The \fBftell()\fR function will fail if:
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBEOVERFLOW\fR\fR
  69 .ad
  70 .RS 13n
  71 The current file offset cannot be represented correctly in an object of type
  72 \fBlong\fR.
  73 .RE
  74
  75 .sp
  76 .LP
  77 The \fBftello()\fR function will fail if:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBEOVERFLOW\fR\fR
  82 .ad
  83 .RS 13n
  84 The current file offset cannot be represented correctly in an object of type
  85 \fBoff_t\fR.
  86 .RE
  87
  88 .SH USAGE
  89 .sp
  90 .LP
  91 The \fBftello()\fR function has a transitional interface for 64-bit file
  92 offsets.  See \fBlf64\fR(5).
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Interface Stability     Standard
 107 _
 108 MT-Level        MT-Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBlseek\fR(2), \fBfopen\fR(3C), \fBfseek\fR(3C), \fBattributes\fR(5), ,
 115 \fBstandards\fR(5), \fBlf64\fR(5)