original/man3/fpurge.3

   1 .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>.
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH FPURGE 3  2001-12-15 "" "Linux Programmer's Manual"
  26 .SH NAME
  27 fpurge, __fpurge \- purge a stream
  28 .SH SYNOPSIS
  29 .nf
  30 /* unsupported */
  31 .B #include <stdio.h>
  32 .sp
  33 .BI "int fpurge(FILE *" stream );
  34 .sp
  35 /* supported */
  36 .B #include <stdio.h>
  37 .br
  38 .B #include <stdio_ext.h>
  39 .sp
  40 .BI "void  __fpurge(FILE *" stream );
  41 .fi
  42 .SH DESCRIPTION
  43 The function
  44 .BR fpurge ()
  45 clears the buffers of the given stream.
  46 For output streams this discards any unwritten output.
  47 For input streams this discards any input read from the underlying object
  48 but not yet obtained via
  49 .BR getc (3);
  50 this includes any text pushed back via
  51 .BR ungetc (3).
  52 See also
  53 .BR fflush (3).
  54 .LP
  55 The function
  56 .BR __fpurge ()
  57 does precisely the same, but without returning a value.
  58 .SH RETURN VALUE
  59 Upon successful completion
  60 .BR fpurge ()
  61 returns 0.
  62 On error, it returns \-1 and sets
  63 .I errno
  64 appropriately.
  65 .SH ERRORS
  66 .TP
  67 .B EBADF
  68 .I stream
  69 is not an open stream.
  70 .SH CONFORMING TO
  71 These functions are nonstandard and not portable.
  72 The function
  73 .BR fpurge ()
  74 was introduced in 4.4BSD and is not available under Linux.
  75 The function
  76 .BR __fpurge ()
  77 was introduced in Solaris, and is present in glibc 2.1.95 and later.
  78 .SH NOTES
  79 Usually it is a mistake to want to discard input buffers.
  80 .SH SEE ALSO
  81 .\" .BR fclean (3),
  82 .BR fflush (3),
  83 .BR setbuf (3),
  84 .BR stdio_ext (3)
  85 .SH COLOPHON
  86 This page is part of release 3.79 of the Linux
  87 .I man-pages
  88 project.
  89 A description of the project,
  90 information about reporting bugs,
  91 and the latest version of this page,
  92 can be found at
  93 \%http://www.kernel.org/doc/man\-pages/.