original/man3/fflush.3

   1 .\" Copyright (c) 1990, 1991 The Regents of the University of California.
   2 .\" 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 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the University of
  20 .\"     California, Berkeley and its contributors.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\" %%%LICENSE_END
  37 .\"
  38 .\"     @(#)fflush.3    5.4 (Berkeley) 6/29/91
  39 .\"
  40 .\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
  41 .\"
  42 .\" Modified 2000-07-22 by Nicolás Lichtmaier <nick@debian.org>
  43 .\" Modified 2001-10-16 by John Levon <moz@compsoc.man.ac.uk>
  44 .\"
  45 .TH FFLUSH 3  2013-07-15 "GNU" "Linux Programmer's Manual"
  46 .SH NAME
  47 fflush \- flush a stream
  48 .SH SYNOPSIS
  49 .B #include <stdio.h>
  50 .sp
  51 .BI "int fflush(FILE *" stream );
  52 .SH DESCRIPTION
  53 For output streams,
  54 .BR fflush ()
  55 forces a write of all user-space buffered data for the given output or update
  56 .I stream
  57 via the stream's underlying write function.
  58 For input streams,
  59 .BR fflush ()
  60 discards any buffered data that has been fetched from the underlying file,
  61 but has not been consumed by the application.
  62 The open status of the stream is unaffected.
  63 .PP
  64 If the
  65 .I stream
  66 argument is NULL,
  67 .BR fflush ()
  68 flushes
  69 .I all
  70 open output streams.
  71 .PP
  72 For a nonlocking counterpart, see
  73 .BR unlocked_stdio (3).
  74 .SH RETURN VALUE
  75 Upon successful completion 0 is returned.
  76 Otherwise,
  77 .B EOF
  78 is returned and
  79 .I errno
  80 is set to indicate the error.
  81 .SH ERRORS
  82 .TP
  83 .B EBADF
  84 .I Stream
  85 is not an open stream, or is not open for writing.
  86 .PP
  87 The function
  88 .BR fflush ()
  89 may also fail and set
  90 .I errno
  91 for any of the errors specified for
  92 .BR write (2).
  93 .SH ATTRIBUTES
  94 .SS Multithreading (see pthreads(7))
  95 The
  96 .BR fflush ()
  97 function is thread-safe.
  98 .SH CONFORMING TO
  99 C89, C99, POSIX.1-2001, POSIX.1-2008.
 100
 101 The standards do not specify the behavior for input streams.
 102 Most other implementations behave the same as Linux.
 103 .\" Verified on: Solaris 8.
 104 .SH NOTES
 105 Note that
 106 .BR fflush ()
 107 only flushes the user-space buffers provided by the C library.
 108 To ensure that the data is physically stored on disk
 109 the kernel buffers must be flushed too, for example, with
 110 .BR sync (2)
 111 or
 112 .BR fsync (2).
 113 .SH SEE ALSO
 114 .BR fsync (2),
 115 .BR sync (2),
 116 .BR write (2),
 117 .BR fclose (3),
 118 .BR fopen (3),
 119 .BR setbuf (3),
 120 .BR unlocked_stdio (3)
 121 .SH COLOPHON
 122 This page is part of release 3.67 of the Linux
 123 .I man-pages
 124 project.
 125 A description of the project,
 126 information about reporting bugs,
 127 and the latest version of this page,
 128 can be found at
 129 \%http://www.kernel.org/doc/man\-pages/.