release/man3/setbuf.3

   1 .\"
   2 .\" Japanese Version Copyright (c) 1999 ishikawa, keisuke
   3 .\"         all rights reserved.
   4 .\" Translated Thu Jan  7 00:03:12 JST 1999
   5 .\"         by ishikawa, keisuke <ishikawa@sgk.gr.jp>
   6 .\" Updated Sat May 19 JST 2001 by Kentaro Shirakata <argrath@ub32.org>
   7 .\" Updated & Modified Sun Jul  1 15:48:32 JST 2001
   8 .\"         by Yuichi SATO <ysato@h4.dion.ne.jp>
   9 .\"
  10 .\" Copyright (c) 1980, 1991 Regents of the University of California.
  11 .\" All rights reserved.
  12 .\"
  13 .\" This code is derived from software contributed to Berkeley by
  14 .\" the American National Standards Committee X3, on Information
  15 .\" Processing Systems.
  16 .\"
  17 .\" Redistribution and use in source and binary forms, with or without
  18 .\" modification, are permitted provided that the following conditions
  19 .\" are met:
  20 .\" 1. Redistributions of source code must retain the above copyright
  21 .\"    notice, this list of conditions and the following disclaimer.
  22 .\" 2. Redistributions in binary form must reproduce the above copyright
  23 .\"    notice, this list of conditions and the following disclaimer in the
  24 .\"    documentation and/or other materials provided with the distribution.
  25 .\" 3. All advertising materials mentioning features or use of this software
  26 .\"    must display the following acknowledgement:
  27 .\"     This product includes software developed by the University of
  28 .\"     California, Berkeley and its contributors.
  29 .\" 4. Neither the name of the University nor the names of its contributors
  30 .\"    may be used to endorse or promote products derived from this software
  31 .\"    without specific prior written permission.
  32 .\"
  33 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  34 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  35 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  36 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  37 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  38 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  39 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  40 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  41 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  42 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  43 .\" SUCH DAMAGE.
  44 .\"
  45 .\"     @(#)setbuf.3    6.10 (Berkeley) 6/29/91
  46 .\"
  47 .\" Converted for Linux, Mon Nov 29 14:55:24 1993, faith@cs.unc.edu
  48 .\" Added section to BUGS, Sun Mar 12 22:28:33 MET 1995,
  49 .\"                   Thomas.Koenig@ciw.uni-karlsruhe.de
  50 .\" Correction,  Sun, 11 Apr 1999 15:55:18,
  51 .\"     Martin Vicente <martin@netadmin.dgac.fr>
  52 .\" Correction,  2000-03-03, Andreas Jaeger <aj@suse.de>
  53 .\" Added return value for setvbuf, aeb,
  54 .\"
  55 .TH SETBUF 3  2008-06-26 "Linux" "Linux Programmer's Manual"
  56 .SH 名前
  57 setbuf, setbuffer, setlinebuf, setvbuf \- ストリームのバッファリングの操作
  58 .SH 書式
  59 .nf
  60 .B #include <stdio.h>
  61
  62 .BI "void setbuf(FILE *" stream ", char *" buf );
  63
  64 .BI "void setbuffer(FILE *" stream ", char *" buf ", size_t "  size );
  65
  66 .BI "void setlinebuf(FILE *" stream );
  67
  68 .BI "int setvbuf(FILE *" stream ", char *" buf ", int " mode \
  69 ", size_t " size );
  70 .fi
  71 .sp
  72 .in -4n
  73 glibc 向けの機能検査マクロの要件
  74 .RB ( feature_test_macros (7)
  75 参照):
  76 .in
  77 .sp
  78 .BR setbuffer (),
  79 .BR setlinebuf ():
  80 _BSD_SOURCE
  81 .SH 説明
  82 バッファリングには unbuffered, block buffered, line buffered の3つのタイプが
  83 ある。出力ストリームのタイプが unbuffered の場合、データを書き込むとすぐに出
  84 力先ファイルに書き込まれるかターミナルに表示される。block buffered の場合、文
  85 字の読み書きはブロック単位でいっぺんに行われる。line buffered の場合、
  86 新しい行が出力されるか、ターミナルデバイスに接続しているストリーム
  87 (通常、\fIstdin\fP) から新しい行が入力されるまで文字がたくわえられる。
  88 ブロックを強制的に出力するには
  89 .BR fflush (3)
  90 関数を使う。
  91 .RB ( fclose (3)
  92 を参照のこと) 通常、ファイルはすべて block buffered である。ファイルに対して
  93 初めて入出力処理を行うと
  94 .BR malloc (3)
  95 が呼び出されバッファが獲得される。もし ストリームが (通常、
  96 .I stdout
  97 がそうであるように) ターミナルを参照する場合には、ファイルは line buffered と
  98 なる。標準エラー出力
  99 .I stderr
 100 はデフォルトでは常に unbuffered である。
 101 .PP
 102 .BR setvbuf ()
 103 関数は、オープンしている任意のストリームに対してバッファを変更できる。
 104 引き数
 105 .I mode
 106 は、次の 3 つのマクロのうちいずれかである:
 107 .RS
 108 .TP
 109 .B _IONBF
 110 unbuffered
 111 .TP
 112 .B _IOLBF
 113 line buffered
 114 .TP
 115 .B _IOFBF
 116 fully buffered
 117 .RE
 118 .PP
 119 unbuffered のファイルを除き、
 120 .I buf
 121 引数は
 122 .I size
 123 バイト以上の大きさのバッファを指していなければならない。このバッファは現在の
 124 バッファの代わりに用いられる。もし、引数
 125 .I buf
 126 が NULL ならば、モードだけが変更される。
 127 新しいバッファは次に読み書きした際に割り当てられる。
 128 .BR setvbuf ()
 129 関数は、ストリームをオープンした後、
 130 そのストリームに対して何らかの操作をする前にのみ使用できる。
 131 .PP
 132 他の 3 つの関数は
 133 .BR setvbuf ()
 134 の呼び出しに単純に置き換えることができる。
 135 .BR setbuf ()
 136 関数は、
 137 .PP
 138 .in +4n
 139 setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);
 140
 141 .in
 142 と全く同等だし、
 143 .BR setbuffer ()
 144 関数は、バッファサイズがデフォルト値
 145 .B BUFSIZ
 146 ではなく引数で与えられる点以外は同じである。
 147 .BR setlinebuf ()
 148 関数は
 149 .PP
 150 .in +4n
 151 setvbuf(stream, (char *) NULL, _IOLBF, 0);
 152
 153 .in
 154 と同じである。
 155 .SH 返り値
 156 .BR setvbuf ()
 157 関数は、成功した場合 0 を返す。
 158 失敗した場合、0 以外の値を返す
 159 (失敗とは、
 160 .I mode
 161 が不正な場合またはリクエストが条件を満たさない場合である)。
 162 .BR setvbuf ()
 163 関数が失敗した場合は
 164 .I errno
 165 を設定することもある。
 166
 167 その他の関数は値を返さない。
 168 .SH 準拠
 169 .BR setbuf ()
 170 関数および
 171 .BR setvbuf ()
 172 関数は C89 と C99 に準拠している。
 173 .SH バグ
 174 .BR setbuffer ()
 175 関数および
 176 .BR setlinebuf ()
 177 関数は 4.2BSD より前の BSD とは互換性がない。また Linux でも(古いバージョン
 178 では)利用できないかもしれない。4.2BSD および 4.3BSD のシステムでは
 179 .BR setbuf ()
 180 は必ず追加のバッファーのサイズを使用するので、これも使うべきでない。
 181 .P
 182 .I stream
 183 を閉じる時 (プログラムを終了する際にもこれは起きる) には、
 184 .I buf
 185 が指し示す空間とが存在していることを保証しなければならない。
 186 例えば、次のような使い方は許されない:
 187 .nf
 188 .sp
 189 #include <stdio.h>
 190
 191 int
 192 main(void)
 193 {
 194     char buf[BUFSIZ];
 195     setbuf(stdin, buf);
 196     printf("Hello, world!\\n");
 197     return 0;
 198 }
 199 .fi
 200 .SH 関連項目
 201 .BR fclose (3),
 202 .BR fflush (3),
 203 .BR fopen (3),
 204 .BR fread (3),
 205 .BR malloc (3),
 206 .BR printf (3),
 207 .BR puts (3)