FPURGE(3) Linux Programmer's Manual FPURGE(3)

NAME
       fpurge, fpurge - purge a stream

SYNOPSIS
       /* unsupported */
       #include 

       int fpurge(FILE *stream);

       /* supported */
       #include 
       #include 

       void  fpurge(FILE *stream);

DESCRIPTION
       The function fpurge() clears the buffers of the given stream.  For out‐
       put 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
       Upon successful completion fpurge() returns 0.  On error, it returns -1
       and sets errno appropriately.

ERRORS
       EBADF  stream is not an open stream.

ATTRIBUTES
       For   an   explanation   of   the  terms  used  in  this  section,  see
       attributes(7).

       ┌───────────┬───────────────┬─────────────────────┐
       │Interface  │ Attribute     │ Value               │
       ├───────────┼───────────────┼─────────────────────┤
       │fpurge() │ Thread safety │ MT-Safe race:stream │
       └───────────┴───────────────┴─────────────────────┘

CONFORMING TO
       These  functions  are  nonstandard  and  not  portable.   The  function
       fpurge()  was  introduced  in  4.4BSD and is not available under Linux.
       The function fpurge() was introduced in Solaris, and  is  present  in
       glibc 2.1.95 and later.

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

SEE ALSO
       fflush(3), setbuf(3), stdioext(3)



                                  2015-07-23                         FPURGE(3)