FTELL(3P)

πŸŽ€ FTELL(3P) β€” bestie edition πŸŽ€

okay so this page is straight out of the POSIX Programmer's Manual, and it's all about ftell and ftello β€” the little functions that tell you where you are in a stream. πŸ’–


✨ PROLOG ✨

Real talk first: this manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (so go check the corresponding Linux manual page for the actual Linux behavior, bestie), or the interface might not even be implemented on Linux at all. πŸ™ˆ


πŸ’… 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 functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional, fr fr. This volume of POSIX.1‐2017 defers to the ISO C standard.

So, the tea: πŸ“

  • The ftell() function shall obtain the current value of the file-position indicator for the stream pointed to by stream.
  • The ftell() function shall not change the setting of errno if successful. (iconic, honestly β€” it minds its own business πŸ’…)
  • The ftello() function shall be equivalent to ftell(), except that the return value is of type off_t and the ftello() function may change the setting of errno if successful. (not me being the chaotic sibling 😭)

πŸ‘‘ RETURN VALUE πŸ‘‘

Upon successful completion, ftell() and ftello() shall return the current value of the file-position indicator for the stream, measured in bytes from the beginning of the file. πŸ“βœ¨

Otherwise β€” and this is the part you gotta know β€” ftell() and ftello() shall return -1, and set errno to indicate the error. 🚨


πŸ’€ ERRORS πŸ’€

The ftell() and ftello() functions shall fail if:

  • EBADF β€” The file descriptor underlying stream is not an open file descriptor. (she's not even open, bestie, what are we doing here)
  • EOVERFLOW β€” For ftell(), the current file offset cannot be represented correctly in an object of type long. 😡
  • EOVERFLOW β€” For ftello(), the current file offset cannot be represented correctly in an object of type off_t. 😡
  • ESPIPE β€” The file descriptor underlying stream is associated with a pipe, FIFO, or socket. (pipes don't play that game, periodt 🚫)
Heads up, the following sections are informative β€” so they're the bonus content, not the rules. 🫢

🌈 EXAMPLES 🌈

None. β€” literally nothing, the section said "no thoughts, head empty" πŸ™ˆ


⭐ APPLICATION USAGE ⭐

None. β€” again, nothing here bestie πŸ’œ


🧚 RATIONALE 🧚

None. β€” the rationale said "I'm gonna sit this one out" ✨


πŸŽ€ FUTURE DIRECTIONS πŸŽ€

None. β€” no plans, no drama, no changes announced πŸ’…


πŸ”₯ SEE ALSO πŸ”₯

  • Section 2.5, Standard I/O Streams, fgetpos(), fopen(), fseek(), lseek()
  • The Base Definitions volume of POSIX.1‐2017, <stdio.h>

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group.

In the event of any discrepancy between this version 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 .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


and that's the whole page, bestie ✨ brought to you by IEEE/The Open Group, 2017 β€” FTELL(3P), signing off πŸ’–πŸ’…πŸ¦‹

πŸ“¦ where this page comes from