fpurge(3) — Linux manual page

fpurge(3)               Library Functions Manual               fpurge(3)

NAME         top

       fpurge, __fpurge - purge a stream

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       /* unsupported */
       #include <stdio.h>

       int fpurge(FILE *stream);

       /* supported */
       #include <stdio.h>
       #include <stdio_ext.h>

       void  __fpurge(FILE *stream);

DESCRIPTION         top

       The function fpurge() clears the buffers of the given stream.
       For output streams this discards any unwritten output.  For input
       streams this discards any input read from the underlying object
       but not yet obtained via getc(3); this includes any text pushed
       back via ungetc(3).  See also fflush(3).

       The function __fpurge() does precisely the same, but without
       returning a value.

RETURN VALUE         top

       Upon successful completion fpurge() returns 0.  On error, it
       returns -1 and sets errno to indicate the error.

ERRORS         top

       EBADF  stream is not an open stream.

ATTRIBUTES         top

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

STANDARDS         top

       None.

HISTORY         top

       fpurge()
              4.4BSD.  Not available under Linux.

       __fpurge()
              Solaris, glibc 2.1.95.

NOTES         top

       Usually it is a mistake to want to discard input buffers.

SEE ALSO         top

       fflush(3), setbuf(3), stdio_ext(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
       man-pages@man7.org

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

Pages that refer to this page: fflush(3),  stdio(3),  stdio_ext(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.