(split) Apply minor changes from v3.32 to v3.35 in the upstream.

[linuxjm/LDP_man-pages.git] / draft / man3 / fflush.3

.\" Copyright (c) 1990, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"     This product includes software developed by the University of
.\"     California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)fflush.3    5.4 (Berkeley) 6/29/91
.\"
.\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
.\"
.\" Modified 2000-07-22 by NicoláÔ Lichtmaier <nick@debian.org>
.\" Modified 2001-10-16 by John Levon <moz@compsoc.man.ac.uk>
.\"
.\" Japanese Version Copyright (c) 1997-2000 YOSHINO Takashi and NAKANO Takeo
.\"       all rights reserved.
.\" Translated 1997-02-13,YOSHINO Takashi <yoshino@civil.jcn.nihon-u.ac.jp>
.\" Update & Modified 1999-03-01, NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\" Update & Modified 2000-09-21, NAKANO Takeo
.\" Updated 2001-11-02, Kentaro Shirakata <argrath@ub32.org>
.\" Updated 2010-04-10, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.24
.\"
.\"WORD:        global variable         Âç°èÊÑ¿ô
.\"WORD:        buffered                ¥Ð¥Ã¥Õ¥¡¥ê¥ó¥°¤µ¤ì¤¿
.\"
.TH FFLUSH 3  2009-09-06 "GNU" "Linux Programmer's Manual"
.\"O .SH NAME
.\"O fflush \- flush a stream
.SH ̾Á°
fflush \- ¥¹¥È¥ê¡¼¥à¤ÎÆâÍƤò¶¯À©Åª¤Ë½ÐÎÏ(¥Õ¥é¥Ã¥·¥å)¤¹¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.B #include <stdio.h>
.sp
.BI "int fflush(FILE *" stream );
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O For output streams,
.\"O .BR fflush ()
.\"O forces a write of all user-space buffered data for the given output or update
.\"O .I stream
.\"O via the stream's underlying write function.
.\"O For input streams,
.\"O .BR fflush ()
.\"O discards any buffered data that has been fetched from the underlying file,
.\"O but has not been consumed by the application.
.\"O The open status of the stream
.\"O is unaffected.
½ÐÎÏ¥¹¥È¥ê¡¼¥à¤Ë´Ø¤·¤Æ¤Ï¡¢
.BR fflush ()
¤Ï¡¢¥æ¡¼¥¶¡¼¶õ´Ö¤Ç¥Ð¥Ã¥Õ¥¡¥ê¥ó¥°¤µ¤ì¤Æ¤¤¤ë¤¹¤Ù¤Æ¤Î¥Ç¡¼¥¿¤ò
»ØÄꤵ¤ì¤¿½ÐÎϤ˽ñ¤­½Ð¤¹ (¥Õ¥é¥Ã¥·¥å¤¹¤ë)¡¢
¤â¤·¤¯¤Ï¥¹¥È¥ê¡¼¥à
.I stream
¤Î²¼°Ì¤Ë¤¢¤ë½ñ¤­¹þ¤ß´Ø¿ô¤òÍѤ¤¤Æ¤³¤Î¥¹¥È¥ê¡¼¥à¤ò¹¹¿·¤¹¤ë¡£
ÆþÎÏ¥¹¥È¥ê¡¼¥à¤Ë´Ø¤·¤Æ¤Ï¡¢
.BR fflush ()
¤Ï¡¢Âбþ¤¹¤ë¥Õ¥¡¥¤¥ë¤«¤é¼èÆÀ¤µ¤ì¤¿¤¬¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤«¤é¤Ï
Æɤ߽Фµ¤ì¤Æ¤¤¤Ê¤¤¥Ð¥Ã¥Õ¥¡¥Ç¡¼¥¿¤òÁ´¤ÆÇË´þ¤¹¤ë¡£
¥¹¥È¥ê¡¼¥à¤Ï³«¤¤¤¿¾õÂ֤ΤޤޤǤ¢¤ê¡¢
¤³¤Î´Ø¿ô¤Ë¤è¤Ã¤Æ²¿¤Î±Æ¶Á¤â¼õ¤±¤Ê¤¤¡£
.PP
.\"O If the
.\"O .I stream
.\"O argument is NULL,
.\"O .BR fflush ()
.\"O flushes
.\"O .I all
.\"O open output streams.
.I stream
°ú¿ô¤¬ .BR NULL ¤Ê¤é¤Ð¡¢
.BR fflush ()
¤Ï³«¤¤¤Æ¤¤¤ë\fI¤¹¤Ù¤Æ¤Î\fR½ÐÎÏ¥¹¥È¥ê¡¼¥à¤ò¥Õ¥é¥Ã¥·¥å¤¹¤ë¡£
.PP
.\"O For nonlocking counterparts, see
.\"O .BR unlocked_stdio (3).
¤³¤ì¤é¤Î½èÍý¤ò¥í¥Ã¥¯¤»¤º¤Ë¹Ô¤¤¤¿¤¤¤È¤­¤Ï¡¢
.BR unlocked_stdio (3)
¤ò»²¾È¤Î¤³¤È¡£
.\"O .SH "RETURN VALUES"
.SH ÊÖ¤êÃÍ
.\"O Upon successful completion 0 is returned.
.\"O Otherwise,
.\"O .B EOF
.\"O is returned and
.\"O .I errno
.\"O is set to indicate the error.
À®¸ù¤¹¤ë¤È 0 ¤¬ÊÖ¤µ¤ì¤ë¡£
¤½¤Î¾¤Î¾ì¹ç¤Ë¤Ï
.B EOF
¤¬ÊÖ¤µ¤ì¡¢
.I errno
¤¬¡¢¥¨¥é¡¼¤ËÂбþ¤·¤¿ÃͤËÀßÄꤵ¤ì¤ë¡£
.\"O .SH ERRORS
.SH ¥¨¥é¡¼
.TP
.B EBADF
.\"O .I Stream
.\"O is not an open stream, or is not open for writing.
.I Stream
¤Ï³«¤¤¤Æ¤¤¤ë¥¹¥È¥ê¡¼¥à¤Ç¤Ï¤Ê¤¤¡£
¤¢¤ë¤¤¤Ï¥¹¥È¥ê¡¼¥à¤Ï½ñ¤­¹þ¤ßÍѤǤϤʤ¤¡£
.PP
.\"O The function
.\"O .BR fflush ()
.\"O may also fail and set
.\"O .I errno
.\"O for any of the errors specified for
.\"O .BR write (2).
.BR fflush ()
´Ø¿ô¤Ï
.BR write (2)
¤Ë´Ø¤·¤Æµ¬Äꤵ¤ì¤Æ¤¤¤ë¥¨¥é¡¼¤Ç¼ºÇÔ¤¹¤ë¤³¤È¤â¤¢¤ë¡£
¤³¤Î¾ì¹ç
.I errno
¤â¤½¤ÎÃͤËÀßÄꤵ¤ì¤ë¡£
.\"O .SH "CONFORMING TO"
.SH ½àµò
C89, C99, POSIX.1-2001, POSIX.1-2008.

.\"O The standards do not specify the behavior for input streams.
.\"O Most other implementations behave the same as Linux.
ɸ½à¤Ç¤Ï¡¢ÆþÎÏ¥¹¥È¥ê¡¼¥à¤ËÂФ¹¤ëÆ°ºî¤Ïµ¬Äꤵ¤ì¤Æ¤¤¤Ê¤¤¡£
¾¤Î¤Û¤È¤ó¤É¤Î¼ÂÁõ¤Ï Linux ¤ÈƱ¤¸Æ°ºî¤ò¤¹¤ë¡£
.\" Verified on: Solaris 8.
.\"O .SH NOTES
.SH Ãí°Õ
.\"O Note that
.\"O .BR fflush ()
.\"O only flushes the user space buffers provided by the C library.
.\"O To ensure that the data is physically stored on disk
.\"O the kernel buffers must be flushed too, for example, with
.\"O .BR sync (2)
.\"O or
.\"O .BR fsync (2).
.BR fflush ()
¤Ï¡¢ C ¥é¥¤¥Ö¥é¥ê¤¬Í¿¤¨¤Æ¤¤¤ë¥æ¡¼¥¶¡¼¶õ´Ö¤Î¥Ð¥Ã¥Õ¥¡¤·¤«¥Õ¥é¥Ã¥·¥å¤·¤Ê¤¤¡£
¥Ç¡¼¥¿¤¬ÊªÍýŪ¤Ë¥Ç¥£¥¹¥¯¤ËÊݸ¤µ¤ì¤ë¤³¤È¤òÊݾڤ·¤¿¤±¤ì¤Ð¡¢
¥«¡¼¥Í¥ë¥Ð¥Ã¥Õ¥¡¤â¥Õ¥é¥Ã¥·¥å¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
¤³¤ì¤Ë¤ÏÎ㤨¤Ð
.BR sync (2)
¤ä
.BR fsync (2)
¤òÍѤ¤¤ë¡£
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR fsync (2),
.BR sync (2),
.BR write (2),
.BR fclose (3),
.BR fopen (3),
.BR setbuf (3),
.BR unlocked_stdio (3)