share/man/man3c/fflush.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH FFLUSH 3C "Nov 1, 2003"
  47 .SH NAME
  48 fflush \- flush a stream
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdio.h>
  53
  54 \fBint\fR \fBfflush\fR(\fBFILE *\fR\fIstream\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 If \fIstream\fR points to an output stream or an update stream in which the
  61 most recent operation was not input, \fBfflush()\fR causes any unwritten data
  62 for that stream to be written to the file, and the \fBst_ctime\fR and
  63 \fBst_mtime\fR fields of the underlying file are marked for update.
  64 .sp
  65 .LP
  66 If \fIstream\fR points to an input stream or an update stream into which the
  67 most recent operation was input, that stream is flushed if it is seekable and
  68 is not already at end-of-file.  Flushing an input stream discards any buffered
  69 input and adjusts the file pointer such that the next input operation accesses
  70 the byte after the last one read.  A stream is seekable if the underlying file
  71 is not a pipe, FIFO, socket, or TTY device.
  72 .sp
  73 .LP
  74 If \fIstream\fR is a null pointer, \fBfflush()\fR performs this flushing action
  75 on all streams for which the behavior is defined above.
  76 .sp
  77 .LP
  78 An input stream, seekable or non-seekable, can be flushed by explicitly calling
  79 \fBfflush()\fR with a non-null argument specifying that stream.
  80 .SH RETURN VALUES
  81 .sp
  82 .LP
  83 Upon successful completion, \fBfflush()\fR returns \fB0\fR. Otherwise, it
  84 returns \fBEOF\fR and sets \fBerrno\fR to indicate the error.
  85 .SH ERRORS
  86 .sp
  87 .LP
  88 The \fBfflush()\fR function will fail if:
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBEAGAIN\fR\fR
  93 .ad
  94 .RS 10n
  95 The \fBO_NONBLOCK\fR flag is set for the file descriptor underlying
  96 \fIstream\fR and the process would be delayed in the write operation.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBEBADF\fR\fR
 103 .ad
 104 .RS 10n
 105 The file descriptor underlying \fIstream\fR is not valid.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBEFBIG\fR\fR
 112 .ad
 113 .RS 10n
 114 An attempt was made to write a file that exceeds the maximum file size or the
 115 process's file size limit; or the file is a regular file and an attempt was
 116 made to write at or beyond the offset maximum associated with the corresponding
 117 stream.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBEINTR\fR\fR
 124 .ad
 125 .RS 10n
 126 The \fBfflush()\fR function was interrupted by a signal.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBEIO\fR\fR
 133 .ad
 134 .RS 10n
 135 The process is a member of a background process group attempting to write to
 136 its controlling terminal, \fBTOSTOP\fR is set, the process is neither ignoring
 137 nor blocking \fBSIGTTOU\fR, and the process group of the process is orphaned.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBENOSPC\fR\fR
 144 .ad
 145 .RS 10n
 146 There was no free space remaining on the device containing the file.
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fBEPIPE\fR\fR
 153 .ad
 154 .RS 10n
 155 An attempt is made to write to a pipe or \fBFIFO\fR that is not open for
 156 reading by any process. A \fBSIGPIPE\fR signal will also be sent to the calling
 157 process.
 158 .RE
 159
 160 .sp
 161 .LP
 162 The \fBfflush()\fR function may fail if:
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fBENXIO\fR\fR
 167 .ad
 168 .RS 9n
 169 A request was made of a non-existent device, or the request was beyond the
 170 limits of the device.
 171 .RE
 172
 173 .SH ATTRIBUTES
 174 .sp
 175 .LP
 176 See \fBattributes\fR(5) for descriptions of the following attributes:
 177 .sp
 178
 179 .sp
 180 .TS
 181 box;
 182 c | c
 183 l | l .
 184 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 185 _
 186 Interface Stability     Standard
 187 _
 188 MT-Level        MT-Safe
 189 .TE
 190
 191 .SH SEE ALSO
 192 .sp
 193 .LP
 194 \fBgetrlimit\fR(2), \fBulimit\fR(2), \fBattributes\fR(5), \fBstandards\fR(5)