release/man3/stdio.3

   1 .\" Copyright (c) 1990, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)stdio.3     6.5 (Berkeley) 5/6/91
  35 .\"
  36 .\" Converted for Linux, Mon Nov 29 16:07:22 1993, faith@cs.unc.edu
  37 .\" Modified, 2001-12-26, aeb
  38 .\"
  39 .\"*******************************************************************
  40 .\"
  41 .\" This file was generated with po4a. Translate the source file.
  42 .\"
  43 .\"*******************************************************************
  44 .TH STDIO 3 2001\-12\-26 "" "Linux Programmer's Manual"
  45 .SH 名前
  46 stdio \- 標準入出力ライブラリ関数
  47 .SH 書式
  48 \fB#include <stdio.h>\fP
  49 .sp
  50 \fBFILE *\fP\fIstdin\fP\fB;\fP
  51 .br
  52 \fBFILE *\fP\fIstdout\fP\fB;\fP
  53 .br
  54 \fBFILE *\fP\fIstderr\fP\fB;\fP
  55 .SH 説明
  56 標準入出力ライブラリは、簡単かつ効果のよい、 バッファリングされたストリーム入出力インターフェースを提供する。
  57 入力と出力は論理データストリームに割り付けられ、 入出力の物理的な特徴は隠蔽される。 このライブラリに属する関数とマクロを以下に挙げる。
  58 より詳しい情報は個々の man ページから得ることができる。
  59 .PP
  60 ファイルを \fIオープン (open) する\fP ことによって、 ストリームは外部ファイル (通常は物理デバイス) に連結される。
  61 この操作には新しくファイルを作成することも含まれる。 既存のファイルと同じ名前のファイルを新たに作ると、 もとのファイルの中身が捨てられてしまう。
  62 ファイルが位置指定リクエストをサポートしている (ディスクファイルなどが相当する。逆の例としては端末が挙げられる) 場合、 そのストリームに連結された
  63 \fIファイル位置指示子 (file position indicator)\fP は、追加モードで開かれない限りファイルの先頭 (0 バイト目)
  64 に位置する。 追加モードを使用した場合、 位置指示子をファイルの先頭に置かれるか末尾に置かれるかは規定されていない。 位置指示子は、
  65 以降の読み書きや位置指定リクエストによって変更される。 すべての入力は、 \fBfgetc\fP(3)
  66 関数を次々に呼び出して文字を読み込んだかのように行われる。 一方すべての出力は、 \fBfputc\fP(3)
  67 関数を次々に呼び出して文字を書き込んだかのように行われる。
  68 .PP
  69 ファイルを \fIクローズ (close) する\fP ことによって、そのファイルはストリームから切り離される。
  70 出力ストリームは、そのストリームがファイルから切り離される前にフラッシュされる (書き込まれていないすべてのバッファの内容がホスト環境に転送される)。
  71 \fIFILE\fP オブジェクトへのポインタの値は、 ファイルを閉じた後では不確定になる (ゴミになってしまう)。
  72 .PP
  73 ファイルはその後 (同じまたは別のプログラムによって)  再びオープンされることもあり、 その内容が修正されたり変更されたりする
  74 (そのファイルで先頭への位置移動が可能であれば)。 main 関数がもとの呼び出し側に返ったり、 \fBexit\fP(3)  関数が呼ばれた場合、
  75 プログラムの終了の前に 現在開いているすべてのファイルは閉じられる (その結果、すべての出力ストリームはフラッシュされる)。 プログラムの停止に
  76 \fBabort\fP(3)  のような他の方法を用いた場合には、 ファイルが正しく閉じられる保証はない。
  77 .PP
  78 プログラムの起動時に 3 個のテキストストリームが予め定義されており、 それらは明示的に開く必要がない。 \fI標準入力 (standard
  79 input)\fP (通常の入力を読み取るのに使う)、 \fI標準出力 (standard output)\fP (通常の出力を書き込むのに使う)、
  80 \fI標準エラー出力 (standard error)\fP (診断出力を書き込むのに使う) である。 これらのストリームは \fIstdin\fP,
  81 \fIstdout\fP, \fIstderr\fP と短縮して表現される。 オープンされたときには、 標準エラーストリームは 完全にはバッファリングされていない。
  82 標準入力ストリームと標準出力ストリームは、 ストリームがインタラクティブなデバイスを参照していなければ、 完全にバッファリングされている。
  83 .PP
  84 端末デバイスを参照する出力ストリームは、 デフォルトでは常に行単位でバッファリングされている。 ただしそのようなストリームにおけるバッファ内の出力は、
  85 端末デバイスを参照している入力ストリームからの読み込みがあるたびに、 自動的に書き込まれる。 出力端末に行の一部を書き込んだ後で大量の計算を行う場合、
  86 出力が表示されるように、計算に取りかかる前に標準出力に対して \fBfflush\fP(3)  を実行する必要がある。
  87 .PP
  88 \fIstdio\fP ライブラリは \fBlibc\fP ライブラリの一部であり、ルーチンは コンパイラー \fBcc\fP(1)  と \fBpc\fP(1)
  89 によって必要な時に自動的に読み込まれる。 後述する man ページ中の「書式」の節には、 どのインクルードファイルを使用しなければならないか、
  90 その関数のコンパイラー宣言はどのようなものか、 どのような外部変数が関係するのかが示されている。
  91 .PP
  92 .\" Not on Linux: .BR fropen ,
  93 .\" Not on Linux: .BR fwopen ,
  94 \fBBUFSIZ\fP, \fBEOF\fP, \fBFILENAME_MAX\fP, \fBFOPEN_MAX\fP, \fBL_cuserid\fP,
  95 \fBL_ctermid\fP, \fBL_tmpnam\fP, \fBNULL\fP, \fBSEEK_END\fP, \fBSEEK_SET\fP, \fBSEEK_CUR\fP,
  96 \fBTMP_MAX\fP, \fBclearerr\fP, \fBfeof\fP, \fBferror\fP, \fBfileno\fP, \fBgetc\fP, \fBgetchar\fP,
  97 \fBputc\fP, \fBputchar\fP, \fBstderr\fP, \fBstdin\fP, \fBstdout\fP はマクロとして定義されている。
  98 これらの名前は、現在の定義を \fB#undef\fP で削除しない限り、再利用することはできない。 マクロ関数の関数版として、 \fBfeof\fP,
  99 \fBferror\fP, \fBclearerr\fP, \fBfileno\fP, \fBgetc\fP, \fBgetchar\fP, \fBputc\fP, \fBputchar\fP
 100 がある。 マクロの定義が明示的に消去されている場合には、 これらを使用することになるだろう。
 101 .SS 関数のリスト
 102 .TS
 103 ;
 104 lb lb
 105 lb l.
 106 関数  説明
 107 _
 108 clearerr        ストリームの状態の確認とリセット
 109 fclose  ストリームをクローズする
 110 fdopen  ストリームをオープンする
 111 feof    ストリームの状態の確認とリセット
 112 ferror  ストリームの状態の確認とリセット
 113 fflush  ストリームをフラッシュする
 114 fgetc   次の文字または語を入力ストリームから獲得する
 115 fgetpos ストリームの位置を取得する
 116 fgets   ストリームから行を取得する
 117 fileno  引き数であるストリームの整数値のディスクリプタを返す
 118 fopen   ストリームをオープンする
 119 fprintf 書式付き出力変換
 120 fpurge  ストリームをフラッシュする
 121 fputc   文字または語をストリームに出力する
 122 fputs   行をストリームに出力する
 123 fread   バイナリーストリーム入出力
 124 freopen ストリームをオープンする
 125 fscanf  書式付き入力変換
 126 fseek   ストリームの位置指示子を移動する
 127 fsetpos ストリームの位置指示子を移動する
 128 ftell   ストリームの位置を取得する
 129 fwrite  バイナリーストリーム入出力
 130 getc    次の文字または語を入力ストリームから取得する
 131 getchar 次の文字または語を入力ストリームから取得する
 132 gets    行を入力ストリームから取得する
 133 getw    次の文字または語を入力ストリームから取得する
 134 mktemp  他と重ならないテンポラリファイル名を作る
 135 perror  システムエラーメッセージ
 136 printf  書式付き出力変換
 137 putc    文字または語をストリームに出力する
 138 putchar 文字または語をストリームに出力する
 139 puts    行をストリームに出力する
 140 putw    文字または語をストリームに出力する
 141 remove  ディレクトリエントリを削除する
 142 rewind  ストリームの位置指示子を移動する
 143 scanf   書式付き入力変換
 144 setbuf  ストリームのバッファリングの操作
 145 setbuffer       ストリームのバッファリングの操作
 146 setlinebuf      ストリームのバッファリングの操作
 147 setvbuf ストリームのバッファリングの操作
 148 sprintf 書式付き出力変換
 149 sscanf  書式付き入力変換
 150 strerror        システムエラーメッセージ
 151 sys_errlist     システムエラーメッセージ
 152 sys_nerr        システムエラーメッセージ
 153 tempnam テンポラリファイルの操作
 154 tmpfile テンポラリファイルの操作
 155 tmpnam  テンポラリファイルの操作
 156 ungetc  入力ストリームへ 1 文字戻す。
 157 vfprintf        書式付き出力変換
 158 vfscanf 書式付き入力変換
 159 vprintf 書式付き出力変換
 160 vscanf  書式付き入力変換
 161 vsprintf        書式付き出力変換
 162 vsscanf 書式付き入力変換
 163 .TE
 164 .SH 準拠
 165 \fIstdio\fP ライブラリは C89 に準拠している。
 166 .SH 関連項目
 167 \fBclose\fP(2), \fBopen\fP(2), \fBread\fP(2), \fBwrite\fP(2), \fBstdout\fP(3),
 168 \fBunlocked_stdio\fP(3)
 169 .SH この文書について
 170 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
 171 である。プロジェクトの説明とバグ報告に関する情報は
 172 http://www.kernel.org/doc/man\-pages/ に書かれている。