lib/libc/stdio/fflush.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)fflush.3    8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd June 4, 1993
  40 .Dt FFLUSH 3
  41 .Os
  42 .Sh NAME
  43 .Nm fflush ,
  44 .Nm fpurge
  45 .Nd flush a stream
  46 .Sh SYNOPSIS
  47 .Fd #include <stdio.h>
  48 .Ft int
  49 .Fn fflush "FILE *stream"
  50 .Ft int
  51 .Fn fpurge "FILE *stream"
  52 .Sh DESCRIPTION
  53 The function
  54 .Fn fflush
  55 forces a write of all buffered data for the given output or update
  56 .Fa stream
  57 via the stream's underlying write function.
  58 The open status of the stream is unaffected.
  59 .Pp
  60 If the
  61 .Fa stream
  62 argument is
  63 .Dv NULL ,
  64 .Fn fflush
  65 flushes
  66 .Em all
  67 open output streams.
  68 .Pp
  69 The function
  70 .Fn fpurge
  71 erases any input or output buffered in the given
  72 .Fa stream .
  73 For output streams this discards any unwritten output.
  74 For input streams this discards any input read from the underlying object
  75 but not yet obtained via
  76 .Xr getc 3 ;
  77 this includes any text pushed back via
  78 .Xr ungetc .
  79 .Sh RETURN VALUES
  80 Upon successful completion 0 is returned.
  81 Otherwise,
  82 .Dv EOF
  83 is returned and the global variable
  84 .Va errno
  85 is set to indicate the error.
  86 .Sh ERRORS
  87 .Bl -tag -width [EBADF]
  88 .It Bq Er EBADF
  89 .Fa Stream
  90 is not an open stream, or, in the case of
  91 .Fn fflush ,
  92 not a stream open for writing.
  93 .El
  94 .Pp
  95 The function
  96 .Fn fflush
  97 may also fail and set
  98 .Va errno
  99 for any of the errors specified for the routine
 100 .Xr write 2 .
 101 .Sh SEE ALSO
 102 .Xr write 2 ,
 103 .Xr fclose 3 ,
 104 .Xr fopen 3 ,
 105 .Xr setbuf 3
 106 .Sh STANDARDS
 107 The
 108 .Fn fflush
 109 function
 110 conforms to
 111 .St -ansiC .