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/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
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.
25 .\" This notice shall appear on any product containing this material.
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.
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.
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]
43 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
46 .TH FFLUSH 3C "Nov 1, 2003"
48 fflush \- flush a stream
54 \fBint\fR \fBfflush\fR(\fBFILE *\fR\fIstream\fR);
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.
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.
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.
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.
83 Upon successful completion, \fBfflush()\fR returns \fB0\fR. Otherwise, it
84 returns \fBEOF\fR and sets \fBerrno\fR to indicate the error.
88 The \fBfflush()\fR function will fail if:
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.
105 The file descriptor underlying \fIstream\fR is not valid.
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
126 The \fBfflush()\fR function was interrupted by a signal.
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.
146 There was no free space remaining on the device containing the file.
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
162 The \fBfflush()\fR function may fail if:
169 A request was made of a non-existent device, or the request was beyond the
170 limits of the device.
176 See \fBattributes\fR(5) for descriptions of the following attributes:
184 ATTRIBUTE TYPE ATTRIBUTE VALUE
186 Interface Stability Standard
194 \fBgetrlimit\fR(2), \fBulimit\fR(2), \fBattributes\fR(5), \fBstandards\fR(5)