FOPEN

Section: Linux Programmer's Manual (3)
Updated: 2020-12-21
Index JM Home Page

名前

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

書式

#include <stdio.h>

FILE *fopen(const char *pathname, const char *mode);

FILE *fdopen(int fd, const char *mode);

FILE *freopen(const char *pathname, const char *mode, FILE *stream);

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

fdopen(): _POSIX_C_SOURCE

説明

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

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

r: テキストファイルを読み出すために開く。ストリームはファイルの先頭に位置される。
r+: 読み出しおよび書き込みするために開く。ストリームはファイルの先頭に位置される。
w: ファイルを書き込みのために開く。ファイルが既に存在する場合には長さゼロに切り詰める。ファイルがなかった場合には新たに作成する。ストリームはファイルの先頭に位置される。
w+: 読み出しおよび書き込みのために開く。ファイルが存在していない場合には新たに作成する。存在している場合には長さゼロに切り詰められる。ストリームはファイルの先頭に位置される。
a: 追加 (ファイルの最後に書き込む) のために開く。ファイルが存在していない場合には新たに作成する。ストリームはファイルの最後に位置される。
a+: Open for reading and appending (writing at end of file). The file is created if it does not exist. Output is always appended to the end of the file. POSIX is silent on what the initial read position is when using this mode. For glibc, the initial file position for reading is at the beginning of the file, but for Android/BSD/MacOS, the initial file position for reading is at the end of the file.

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

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

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

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

fseek(stream, 0, SEEK_END);

The file descriptor associated with the stream is opened as if by a call to open(2) with the following flags:

fopen() モード	open() フラグ
r	O_RDONLY
w	O_WRONLY \| O_CREAT \| O_TRUNC
a	O_WRONLY \| O_CREAT \| O_APPEND
r+	O_RDWR
w+	O_RDWR \| O_CREAT \| O_TRUNC
a+	O_RDWR \| O_CREAT \| O_APPEND

fdopen()

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

freopen()

freopen() 関数は path で名前が指定されたファイルを開き、 stream で指定されたストリームに、そのファイルを結びつける。もとのストリームは (もし存在する場合には) 閉じられる。 mode 引数は fopen() 関数と同じ形で使われる。

If the pathname argument is a null pointer, freopen() changes the mode of the stream to that specified in mode; that is, freopen() reopens the pathname that is associated with the stream. The specification for this behavior was added in the C99 standard, which says:

In this case, the file descriptor associated with the stream need not be closed if the call to freopen() succeeds. It is implementation-defined which changes of mode are permitted (if any), and under what circumstances.

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 をセットする。

属性

この節で使用されている用語の説明については、 attributes(7) を参照。

インターフェース	属性	値
fopen(), fdopen(), freopen()	Thread safety	MT-Safe

準拠

fopen(), freopen(): POSIX.1-2001, POSIX.1-2008, C89, C99.

fdopen(): POSIX.1-2001, POSIX.1-2008.

注意

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 しか解釈されない。

この文書について

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

Linux マニュアル一覧

[man1] [man2] [man3] [man4] [man5] [man6] [man7] [man8]
[a] [b] [c] [d] [e] [f] [g] [h] [i] [j] [k] [l] [m] [n] [o] [p] [q] [r] [s] [t] [u] [v] [w] [x] [y] [z]