名称

fgetwln — ストリームからワイド文字の 1 行を取得する

ライブラリ

Standard C Library (libc, -lc)

書式

#include < stdio.h>
#include < wchar.h>

wchar_t *
fgetwln( FILE * restrict stream, size_t * restrict len);

解説

fgetwln() 関数は、 stream で参照されるストリームから次の行のポインタを返します。この行の最後はヌルワイド文字で終っていませんので、標準のワイド文字列では ありません。 最後の改行も含めた行の長さは、 len が指すメモリ位置に格納されます。 (しかしながら、改行で終わらないファイルの最後の行であるなら、返されるテキストに改行は含まれないことに注意してください。)

戻り値

成功して終了すると、ポインタが戻されます。このポインタは、次に stream の I/O 操作 (成功であれ失敗であれ) を行った後とストリームがクローズされた直後では無効になります。そうでなければ NULL が返されます。 fgetwln() 関数は、ファイルの終了とエラーを区別しません。どちらが起こったかを判断するには、ルーチン feof(3) および ferror(3) を使用しなければなりません。エラーが発生した場合は、グローバル変数 errno にエラーを示す値が設定されます。ファイルの終了状態はたとえ端末であっても記憶され、 clearerr(3) で状態がクリアされるまでは、その後の読み込みの試みてもすべて NULL が返されます。

返されたポインタが指し示すテキストは、返されたサイズを超えて変更しないならば修正できます。これらの変更は、ポインタが無効になると失われます。

エラー

[ EBADF]

引数 stream は、読み込みのためにオープンしたストリームではありません。

また、 fgetwln() 関数が失敗するなら、ルーチン mbrtowc(3), realloc(3), read(2) に明記されたエラーのいずれかが errno に設定されます。

関連項目

ferror(3), fgetln(3), fgetws(3), fopen(3)