UNGETC(3POSIX)

✨ PROLOG ✨

Ok bestie, real talk before we even start πŸ’– this page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (so go peek at the corresponding Linux manual page for the deets on Linux behavior), or the interface might not even be implemented on Linux at all. Not me warning you upfront 😭


🌸 NAME 🌸

ungetc β€” push byte back into input stream 🫢


πŸŽ€ SYNOPSIS πŸŽ€

#include <stdio.h>

int ungetc(int c, FILE *stream);

πŸ’… DESCRIPTION πŸ’…

So the functionality on this reference page is aligned with the ISO C standard. If anything here conflicts with what the ISO C standard says, that conflict is unintentional, okay? No cap. This volume of POSIX.1‐2017 defers to the ISO C standard. Periodt.

The ungetc() function shall push the byte specified by c (converted to an unsigned char) back onto the input stream pointed to by stream. The pushed-back bytes shall be returned by subsequent reads on that stream in the reverse order of their pushing. Like a little stack, iykyk πŸ”₯

A successful intervening call (with the stream pointed to by stream) to a file-positioning function (fseek(), fseeko(), fsetpos(), or rewind()) or fflush() shall discard any pushed-back bytes for the stream. The external storage corresponding to the stream shall be unchanged. We're not touching the actual file, bestie, just the vibe of the stream ✨

One byte of push-back shall be provided. If ungetc() is called too many times on the same stream without an intervening read or file-positioning operation on that stream, the operation may fail. πŸ’€

If the value of c equals that of the macro EOF, the operation shall fail and the input stream shall be left unchanged.

A successful call to ungetc() shall clear the end-of-file indicator for the stream. The value of the file-position indicator for the stream after all pushed-back bytes have been read, or discarded by calling fseek(), fseeko(), fsetpos(), or rewind() (but not fflush()), shall be the same as it was before the bytes were pushed back. The file-position indicator is decremented by each successful call to ungetc(); if its value was 0 before a call, its value is unspecified after the call. So like... don't be weird about it πŸ™ˆ


⭐ RETURN VALUE ⭐

Upon successful completion, ungetc() shall return the byte pushed back after conversion. Otherwise, it shall return EOF. Slay when it works, EOF when it doesn't πŸ’–


πŸ¦‹ ERRORS πŸ¦‹

No errors are defined.

The following sections are informative. (Read: they're the chill bonus sections, not the rules πŸ“–)


🌈 EXAMPLES 🌈

None.


πŸ’œ APPLICATION USAGE πŸ’œ

None.


🧚 RATIONALE 🧚

None.


πŸ“ FUTURE DIRECTIONS πŸ“

None.


πŸ‘‘ SEE ALSO πŸ‘‘

  • Section 2.5, Standard I/O Streams
  • fseek()
  • getc()
  • fsetpos()
  • read()
  • rewind()
  • setbuf()

The Base Definitions volume of POSIX.1‐2017, <stdio.h> β€” go read that one too bestie, it's giving foundational 🌸


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 .


Okay that's the whole page, no notes πŸ’… This little legend came from IEEE/The Open Group, dated 2017, filed under UNGETC(3POSIX). Mwah, go push some bytes back 🫢✨