xref: /illumos-gate/usr/src/man/man3c/ftell.3c (revision b6805bf78d2bbbeeaea8909a05623587b42d58b3)
te
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
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
http://www.opengroup.org/bookstore/.
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.
This notice shall appear on any product containing this material.
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.
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.
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]
FTELL 3C "Jul 24, 2002"
NAME
ftell, ftello - return a file offset in a stream
SYNOPSIS

#include <stdio.h>

long ftell(FILE *stream);

off_t ftello(FILE *stream);
DESCRIPTION

The ftell() function obtains the current value of the file-position indicator for the stream pointed to by stream. The ftello() function is identical to ftell() except for the return type.

RETURN VALUES

Upon successful completion, the ftell() and ftello() functions return the current value of the file-position indicator for the stream measured in bytes from the beginning of the file. Otherwise, they return -1 and sets errno to indicate the error.

ERRORS

The ftell() and ftello() functions will fail if: EBADF

The file descriptor underlying stream is not an open file descriptor.

ESPIPE

The file descriptor underlying stream is associated with a pipe, a FIFO, or a socket.

The ftell() function will fail if: EOVERFLOW

The current file offset cannot be represented correctly in an object of type long.

The ftello() function will fail if: EOVERFLOW

The current file offset cannot be represented correctly in an object of type off_t.

USAGE

The ftello() function has a transitional interface for 64-bit file offsets. See lf64(5).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

lseek(2), fopen(3C), fseek(3C), attributes(5), , standards(5), lf64(5)