ungetwc(3) — Linux manual page

ungetwc(3)              Library Functions Manual              ungetwc(3)

NAME         top

       ungetwc - push back a wide character onto a FILE stream

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <wchar.h>

       wint_t ungetwc(wint_t wc, FILE *stream);

DESCRIPTION         top

       The ungetwc() function is the wide-character equivalent of the
       ungetc(3) function.  It pushes back a wide character onto stream
       and returns it.

       If wc is WEOF, it returns WEOF.  If wc is an invalid wide
       character, it sets errno to EILSEQ and returns WEOF.

       If wc is a valid wide character, it is pushed back onto the
       stream and thus becomes available for future wide-character read
       operations.  The file-position indicator is decremented by one or
       more.  The end-of-file indicator is cleared.  The backing storage
       of the file is not affected.

       Note: wc need not be the last wide-character read from the
       stream; it can be any other valid wide character.

       If the implementation supports multiple push-back operations in a
       row, the pushed-back wide characters will be read in reverse
       order; however, only one level of push-back is guaranteed.

RETURN VALUE         top

       The ungetwc() function returns wc when successful, or WEOF upon
       failure.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           │ Attribute     │ Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ ungetwc()                           │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       C11, POSIX.1-2008.

HISTORY         top

       POSIX.1-2001, C99.

NOTES         top

       The behavior of ungetwc() depends on the LC_CTYPE category of the
       current locale.

SEE ALSO         top

       fgetwc(3)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       [email protected]

Linux man-pages 6.9.1          2024-05-02                     ungetwc(3)

Pages that refer to this page: fgetc(3),  fgetwc(3),  gets(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.