release/man3/fopen.3

   1 .\" Copyright (c) 1990, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the University of
  20 .\"     California, Berkeley and its contributors.
  21 .\" 4. Neither the name of the University nor the names of its contributors
  22 .\"    may be used to endorse or promote products derived from this software
  23 .\"    without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35 .\" SUCH DAMAGE.
  36 .\" %%%LICENSE_END
  37 .\"
  38 .\"     @(#)fopen.3     6.8 (Berkeley) 6/29/91
  39 .\"
  40 .\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
  41 .\" Modified, aeb, 960421, 970806
  42 .\" Modified, joey, aeb, 2002-01-03
  43 .\"
  44 .\"*******************************************************************
  45 .\"
  46 .\" This file was generated with po4a. Translate the source file.
  47 .\"
  48 .\"*******************************************************************
  49 .TH FOPEN 3 2012\-04\-22 GNU "Linux Programmer's Manual"
  50 .SH 名前
  51 fopen, fdopen, freopen \- ストリームを開く関数
  52 .SH 書式
  53 .nf
  54 \fB#include <stdio.h>\fP
  55 .sp
  56 \fBFILE *fopen(const char *\fP\fIpath\fP\fB, const char *\fP\fImode\fP\fB);\fP
  57
  58 \fBFILE *fdopen(int \fP\fIfd\fP\fB, const char *\fP\fImode\fP\fB);\fP
  59
  60 \fBFILE *freopen(const char *\fP\fIpath\fP\fB, const char *\fP\fImode\fP\fB, FILE *\fP\fIstream\fP\fB);\fP
  61 .fi
  62 .sp
  63 .in -4n
  64 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  65 .in
  66 .sp
  67 \fBfdopen\fP(): _POSIX_C_SOURCE\ >=\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE
  68 .SH 説明
  69 \fBfopen\fP()  関数は、 \fIpath\fP で指定された名前のファイルを開き、ストリームと結びつける。
  70 .PP
  71 引数 \fImode\fP は、以下に続く文字のひとつから始まる文字列へのポインタであ
  72 る (以下の述べる、追加の文字が後に続くこともある):
  73 .TP
  74 \fBr\fP
  75 テキストファイルを読み出すために開く。 ストリームはファイルの先頭に位置される。
  76 .TP
  77 \fBr+\fP
  78 読み出しおよび書き込みするために開く。 ストリームはファイルの先頭に位置される。
  79 .TP
  80 \fBw\fP
  81 ファイルを書き込みのために開く。 ファイルが既に存在する場合には長さゼロに切り詰める。 ファイルがなかった場合には新たに作成する。
  82 ストリームはファイルの先頭に位置される。
  83 .TP
  84 \fBw+\fP
  85 読み出しおよび書き込みのために開く。 ファイルが存在していない場合には新たに作成する。 存在している場合には長さゼロに切り詰められる。
  86 ストリームはファイルの先頭に位置される。
  87 .TP
  88 \fBa\fP
  89 追加 (ファイルの最後に書き込む) のために開く。 ファイルが存在していない場合には新たに作成する。 ストリームはファイルの最後に位置される。
  90 .TP
  91 \fBa+\fP
  92 読み出しおよび追加 (ファイルの最後に書き込む) のために開く。 ファイルが存在していない場合には新たに作成する。
  93 読み出しの初期ファイル位置はファイルの先頭であるが、 書き込みは常にファイルの最後に追加される。
  94 .PP
  95 \fImode\fP 文字列には文字 \(aqb\(aq を追加指定することができ、 \fImode\fP 文字列の最後の文字として指定する。 上記のうち 2
  96 文字のモードの場合には 2 つの文字の間に指定することもできる。 これは C89 との互換性のためだけに用意された
  97 ものであり、関数の実行に対してはいかなる影響も持たない。 すなわち、Linux を含む全ての POSIX 準拠システムでは、 この \(aqb\(aq
  98 は無視される。 (その他のシステムではテキストファイルとバイナリファイルを別々に扱うものもあるので、 もしバイナリファイルの入出力を行い、
  99 そのプログラムが非 UNIX 環境へ移植されると予測するなら、 \(aqb\(aqを付けておくのは良い考えである)
 100 .PP
 101 \fImode\fP の glibc による拡張の詳細については下記の「注意」を参照。
 102 .PP
 103 すべての生成されたファイルは、 \fBS_IRUSR\fP | \fBS_IWUSR\fP | \fBS_IRGRP\fP | \fBS_IWGRP\fP |
 104 \fBS_IROTH\fP | \fBS_IWOTH\fP (0666) のモードを そのプロセスの umask 値によって修正したモードを持つ
 105 (\fBumask\fP(2)  を見よ)。
 106 .PP
 107 読み出し/書き込みストリームに対しては任意の順序で読み書きを行うことができる。 ただし ANSI C では、
 108 (入力操作がファイルの末尾に到達した場合を除いて)  出力と入力の間にはファイルの位置決め関数を 挟まなければならないことになっていることに注意されたい
 109 (この条件を満足しない場合には、読み込み操作は、 最後に書き込まれたものでなく、以前に書き込まれた 値を返すことを許されている)。
 110 したがって、このようなストリームでの読み書き操作の間には \fBfseek\fP(3)  または \fBfgetpos\fP(3)  操作を挟んでおくと良いだろう
 111 (Linux では本当に必要となることもときどきある)。 この操作は見かけ上何もしない操作 (no\-op) でも良い (例えば \fIfseek(...,
 112 0L, SEEK_CUR)\fP を その副次的効果である同期のためだけに呼べば良い)。
 113 .PP
 114 ファイルを追加モード (\fImode\fP の最初の文字を \fBa\fP にする) で開くと、
 115 このストリームに対する書き込み操作は全て (先に以下の呼び出しを行った
 116 かのように) ファイルの末尾で行われる。
 117 .nf
 118
 119     fseek(stream, 0, SEEK_END);
 120 .fi
 121 .PP
 122 \fBfdopen\fP()  関数は、既存のファイル記述子 \fIfd\fP にストリームを結びつける。 ストリームの \fImode\fP ("r", "r+",
 123 "w", "w+", "a", "a+" のいずれか) は ファイル記述子のモードと互換のものでなければならない。
 124 新しいストリームのファイル位置指示子は \fIfd\fP に属している値に設定される。 error と end\-of\-file の各指示子はクリアされる。
 125 "w" および "w+" モードでのファイルの切り詰めは行われない。 ファイル記述子の複製は行なわれない。 \fBfdopen\fP()
 126 で作成されたストリームが閉じられたときにファイル記述子も 閉じられる。 共有メモリのオブジェクトへ \fBfdopen\fP()
 127 を行ったときの結果は定義されていない。
 128 .PP
 129 \fBfreopen\fP()  関数は \fIpath\fP で名前が指定されたファイルを開き、 \fIstream\fP
 130 で指定されたストリームに、そのファイルを結びつける。 もとのストリームは (もし存在する場合には) 閉じられる。 \fImode\fP 引数は
 131 \fBfopen\fP()  関数と同じ形で使われる。 \fBfreopen\fP()  関数の主な用途は、標準テキストストリーム (\fIstderr\fP,
 132 \fIstdin\fP, \fIstdout\fP)  と対応付けられているファイルを変更することである。
 133 .SH 返り値
 134 \fBfopen\fP(), \fBfdopen\fP(), \fBfreopen\fP()  は成功すると \fIFILE\fP 型のポインタを返す。 失敗すると NULL
 135 が返され、 \fIerrno\fP がエラーを示す値にセットされる。
 136 .SH エラー
 137 .TP
 138 \fBEINVAL\fP
 139 \fBfopen\fP(), \fBfdopen\fP(), \fBfreopen\fP()  で与えられた \fImode\fP が不適切である。
 140 .PP
 141 \fBfopen\fP(), \fBfdopen\fP(), \fBfreopen\fP()  関数は \fBmalloc\fP(3)
 142 ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に \fIerrno\fP をセットする。
 143 .PP
 144 \fBfopen\fP()  関数は \fBopen\fP(2)  ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に \fIerrno\fP
 145 をセットする。
 146 .PP
 147 \fBfdopen\fP()  関数は \fBfcntl\fP(2)  ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に
 148 \fIerrno\fP をセットする。
 149 .PP
 150 \fBfreopen\fP()  関数は \fBopen\fP(2), \fBfclose\fP(3), \fBfflush\fP(3)
 151 各ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に \fIerrno\fP をセットする。
 152 .SH 準拠
 153 \fBfopen\fP()  関数と \fBfreopen\fP()  関数は C89に準拠している。 \fBfdopen\fP()  関数は POSIX.1\-1990
 154 に準拠している。
 155 .SH 注意
 156 .SS "glibc での注意"
 157 GNU C ライブラリでは、 \fImode\fP に指定できる文字列として、以下の拡張が行われている:
 158 .TP
 159 \fBc\fP (glibc 2.3.3 以降)
 160 open 操作、それに続く read/write 操作の、 スレッドの取り消しポイント
 161 (cancellation points) を作成しない。
 162 このフラグは \fBfdopen\fP() では無視される。
 163 .TP
 164 \fBe\fP (glibc 2.7 以降)
 165 \fBO_CLOEXEC\fP フラグを有効にしてファイルをオープンする。詳細は
 166 \fBopen\fP(2) を参照。このフラグは \fBfdopen\fP() では無視される。
 167 .TP
 168 \fBm\fP (glibc 2.3 以降)
 169 .\" As at glibc 2.4:
 170 I/O システムコール (\fBread\fP(2), \fBwrite\fP(2))  ではなく、 \fBmmap\fP(2)
 171 を使ってファイルにアクセスしようとする。 \fBmmap\fP(2)  を使おうとするのは、読み出し用にオープンするファイルについてだけである。
 172 .TP
 173 \fBx\fP
 174 .\" Since glibc 2.0?
 175 .\" FIXME C11 specifies this flag
 176 ファイルを排他的にオープンする (\fBopen\fP(2)  の \fBO_EXCL\fP フラグと同様)。 ファイルがすでに存在する場合、 \fBfopen\fP()
 177 は失敗し、 \fIerrno\fP に \fBEEXIST\fP がセットされる。 このフラグは \fBfdopen\fP()  では無視される。
 178 .PP
 179 上記の文字に加えて、
 180 \fBfopen\fP() と \fBfreopen\fP() では \fImode\fP に
 181 以下の書式を 指定することができる。
 182
 183 \fB ,ccs=\fP\fIstring\fP
 184
 185 指定された \fIstring\fP は、符号化文字集合の名前と解釈され、
 186 ストリームではワイド文字のストリームとして扱われる。
 187 内部変換関数で入出力時に文字集合 \fIstring\fP との変換が行われる。
 188 書式 \fB,ccs=\fP\fIstring\fP が指定されない場合は、
 189 ストリームをワイド文字のストリームとして扱うかは
 190 最初のファイル操作時に決定される。
 191 最初のファイル操作がワイド文字操作であった場合は、
 192 そのストリームはワイド文字のストリームとして扱われ、
 193 符号化文字集合との変換を行う関数が読み込まれる。
 194 .SH バグ
 195 .\" FIXME http://sourceware.org/bugzilla/show_bug.cgi?id=12685
 196 \fImode\fP の個々のフラグ文字 ("ccs" 指定の前の文字) を解釈する際に、
 197 glibc の \fBfopen\fP() と \fBfreopen\fP() の実装では、
 198 \fImode\fP の確認を最大 7 文字しか行わないという制限がある
 199 (バージョン 2.14 より前の glibc では最大 6 文字だが、
 200 6 文字では "rb+cmxe" などの指定を行うには不十分であった)。
 201 \fBfdopen\fP() の現在の実装では最大 5 文字の \fImode\fP しか解釈されない。
 202 .SH 関連項目
 203 \fBopen\fP(2), \fBfclose\fP(3), \fBfileno\fP(3), \fBfmemopen\fP(3), \fBfopencookie\fP(3)
 204 .SH この文書について
 205 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 206 である。プロジェクトの説明とバグ報告に関する情報は
 207 http://www.kernel.org/doc/man\-pages/ に書かれている。