lib/libc/stdio/fflush.3

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