FOPEN(3)

名前
fopen, fdopen, freopen - ストリームを開く関数

書式
#include <stdio.h>

FILE *fopen(const char *path, const char *mode);
FILE *fdopen(int fd, const char *mode);
FILE *freopen(const char *path, const char *mode, FILE *stream);

glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

fdopen(): _POSIX_C_SOURCE >= 1 || _XOPEN_SOURCE || _POSIX_SOURCE

説明
fopen() 関数は、 path で指定された名前のファイルを開き、ストリームと結びつける。

引数 mode は、以下に続く文字のひとつから始まる文字列へのポインタであ る (以下の述べる、追加の文字が後に続くこともある):

r   テキストファイルを読み出すために開く。 ストリームはファイルの先頭に位置される。

r+  読み出しおよび書き込みするために開く。 ストリームはファイルの先頭に位置される。

w   ファイルを書き込みのために開く。 ファイルが既に存在する場合には長さゼロに切り詰める。 ファイルがなかった場合には新たに作成する。 ストリームはファイルの先頭に位置される。

w+  読み出しおよび書き込みのために開く。 ファイルが存在していない場合には新たに作成する。 存在している場合には長さゼロに切り詰められる。 ストリームはファイルの先頭に位置される。

a   追加 (ファイルの最後に書き込む) のために開く。 ファイルが存在していない場合には新たに作成する。 ストリームはファイルの最後に位置される。

a+  読み出しおよび追加 (ファイルの最後に書き込む) のために開く。 ファイルが存在していない場合には新たに作成する。 読み出しの初期ファイル位置はファイルの先頭であるが、 書き込みは常にファイルの最後に追加される。

mode 文字列には文字 'b' を追加指定することができ、 mode 文字列の最後の文字として指定する。 上記のうち 2 文字のモードの場合には 2 つの文字の間に指定することもできる。 これは C89 との互換性のためだけに用意された ものであり、関数の実行に対してはいかなる影響も持たない。 すなわち、Linux を含む全ての POSIX 準拠システムでは、 この 'b' は無視される。 (その他のシステムではテキストファイルとバイナリファイルを別々に扱うものもあるので、 もしバイナリファイルの入出力を行い、 そのプログラムが非 UNIX 環境へ移植されると予測するなら、 'b'を付けておくのは良い考えである)

mode の glibc による拡張の詳細については下記の「注意」を参照。

すべての生成されたファイルは、 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH (0666) のモードを そのプロセスの umask 値によって修正したモードを持つ (umask(2) を見よ)。

読み出し/書き込みストリームに対しては任意の順序で読み書きを行うことができる。 ただし ANSI C では、 (入力操作がファイルの末尾に到達した場合を除いて) 出力と入力の間にはファイルの位置決め関数を 挟まなければならないことになっていることに注意されたい (この条件を満足しない場合には、読み込み操作は、 最後に書き込まれたものでなく、以前に書き込まれた 値を返すことを許されている)。 したがって、このようなストリームでの読み書き操作の間には fseek(3) または fgetpos(3) 操作を挟んでおくと良いだろう (Linux では本当に必要となることもときどきある)。 この操作は見かけ上何もしない操作 (no-op) でも良い (例えば fseek(..., 0L, SEEK_CUR) を その副次的効果である同期のためだけに呼べば良い)。

ファイルを追加モード (mode の最初の文字を a にする) で開くと、 このストリームに対する書き込み操作は全て (先に以下の呼び出しを行った かのように) ファイルの末尾で行われる。
    fseek(stream, 0, SEEK_END);

fdopen() 関数は、既存のファイル記述子 fd にストリームを結びつける。 ストリームの mode ("r", "r+", "w", "w+", "a", "a+" のいずれか) は ファイル記述子のモードと互換のものでなければならない。 新しいストリームのファイル位置指示子は fd に属している値に設定される。 error と end-of-file の各指示子はクリアされる。 "w" および "w+" モードでのファイルの切り詰めは行われない。 ファイル記述子の複製は行なわれない。 fdopen() で作成されたストリームが閉じられたときにファイル記述子も 閉じられる。 共有メモリのオブジェクトへ fdopen() を行ったときの結果は定義されていない。

freopen() 関数は path で名前が指定されたファイルを開き、 stream で指定されたストリームに、そのファイルを結びつける。 もとのストリームは (もし存在する場合には) 閉じられる。 mode 引数は fopen() 関数と同じ形で使われる。 freopen() 関数の主な用途は、標準テキストストリーム (stderr, stdin, stdout) と対応付けられているファイルを変更することである。

返り値
fopen(), fdopen(), freopen() は成功すると FILE 型のポインタを返す。 失敗すると NULL が返され、 errno がエラーを示す値にセットされる。

エラー

EINVAL
    fopen(), fdopen(), freopen() で与えられた mode が不適切である。

fopen(), fdopen(), freopen() 関数は malloc(3) ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に errno をセットする。

fopen() 関数は open(2) ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に errno をセットする。

fdopen() 関数は fcntl(2) ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に errno をセットする。

freopen() 関数は open(2), fclose(3), fflush(3) 各ルーチンで規定されているエラーでも失敗することがあり、 その時は対応する値に errno をセットする。

準拠
fopen() 関数と freopen() 関数は C89に準拠している。 fdopen() 関数は POSIX.1-1990 に準拠している。

注意

  glibc での注意
GNU C ライブラリでは、 mode に指定できる文字列として、以下の拡張が行われている:

c (glibc 2.3.3 以降)
    open 操作、それに続く read/write 操作の、 スレッドの取り消しポイント (cancellation points) を作成しない。 このフラグは fdopen() では無視される。

e (glibc 2.7 以降)
    O_CLOEXEC フラグを有効にしてファイルをオープンする。詳細は open(2) を参照。このフラグは fdopen() では無視される。

m (glibc 2.3 以降)
    I/O システムコール (read(2), write(2)) ではなく、 mmap(2) を使ってファイルにアクセスしようとする。 mmap(2) を使おうとするのは、読み出し用にオープンするファイルについてだけである。

x   ファイルを排他的にオープンする (open(2) の O_EXCL フラグと同様)。 ファイルがすでに存在する場合、 fopen() は失敗し、 errno に EEXIST がセットされる。 このフラグは fdopen() では無視される。

上記の文字に加えて、 fopen() と freopen() では mode に 以下の書式を 指定することができる。 ,ccs=string 指定された string は、符号化文字集合の名前と解釈され、 ストリームではワイド文字のストリームとして扱われる。 内部変換関数で入出力時に文字集合 string との変換が行われる。 書式 ,ccs=string が指定されない場合は、 ストリームをワイド文字のストリームとして扱うかは 最初のファイル操作時に決定される。 最初のファイル操作がワイド文字操作であった場合は、 そのストリームはワイド文字のストリームとして扱われ、 符号化文字集合との変換を行う関数が読み込まれる。

バグ
mode の個々のフラグ文字 ("ccs" 指定の前の文字) を解釈する際に、 glibc の fopen() と freopen() の実装では、 mode の確認を最大 7 文字しか行わないという制限がある (バージョン 2.14 より前の glibc では最大 6 文字だが、 6 文字では "rb+cmxe" などの指定を行うには不十分であった)。 fdopen() の現在の実装では最大 5 文字の mode しか解釈されない。

関連項目
open(2), fclose(3), fileno(3), fmemopen(3), fopencookie(3)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 3.54 の一部 である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。