1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <meta http-equiv=
"Content-Type" content=
"text/html; charset=utf-8">
5 <meta http-equiv=
"Content-Style-Type" content=
"text/css">
6 <link rel=
"up" title=
"FatFs" href=
"../00index_j.html">
7 <link rel=
"alternate" hreflang=
"en" title=
"English" href=
"../en/gets.html">
8 <link rel=
"stylesheet" href=
"../css_j.css" type=
"text/css" media=
"screen" title=
"ELM Default">
9 <title>FatFs - f_gets
</title>
14 <div class=
"para func">
16 <p>ファイルから文字列を読み出します。
</p>
19 TCHAR*
<span class=
"arg">buff
</span>,
<span class=
"c">/* [OUT] バッファ */
</span>
20 int
<span class=
"arg">len
</span>,
<span class=
"c">/* [IN] バッファのサイズ */
</span>
21 FIL*
<span class=
"arg">fp
</span> <span class=
"c">/* [IN] ファイル オブジェクト */
</span>
26 <div class=
"para arg">
30 <dd>文字列を読み出すバッファを指すポインタを指定します。
</dd>
32 <dd>バッファのサイズを要素数で指定します。
</dd>
34 <dd>ファイル オブジェクト構造体へのポインタを指定します。
</dd>
39 <div class=
"para ret">
41 <p>関数が成功すると
<tt class=
"arg">buff
</tt>が返されます。
</p>
45 <div class=
"para desc">
47 <p>読み出し動作は、最初の
<tt>'\n'
</tt>を読み込むか、ファイル終端に達するか、
<tt class=
"arg">len
</tt> -
1文字を読み出すまで続きます。読み込まれた文字列の終端には
<tt>'\
0'
</tt>が付加されます。既にファイル終端で
1文字も読み込まれなかったとき、または何らかのエラーが発生したときは関数は失敗しヌル ポインタを返します。ファイル終端かエラーかは
<tt>f_eof/f_error
</tt>関数で調べられます。
</p>
48 <p>Unicode API構成(
<tt>_LFN_UNICODE ==
1</tt>)が選択されているときは、
<tt class=
"arg">buff
</tt>はUTF-
16文字列になりますが、ファイル上のエンコードは、
<tt>_STRF_ENCODE
</tt>オプションで選択できます。それ以外の時は無変換(
1バイト/
1文字)で読み出します。
</p>
52 <div class=
"para comp">
54 <p>この関数は
<a href=
"read.html"><tt>f_read
</tt></a>関数のラッパー関数です。
<tt>_USE_STRFUNC
</tt>が
1または
2のとき使用可能です。
2のときは、ファイルに含まれる
<tt>'\r'
</tt>が取り除かれてバッファに読み込まれます。
</p>
58 <div class=
"para ref">
60 <p><tt><a href=
"open.html">f_open
</a>,
<a href=
"read.html">f_read
</a>,
<a href=
"putc.html">f_putc
</a>,
<a href=
"puts.html">f_puts
</a>,
<a href=
"printf.html">f_printf
</a>,
<a href=
"close.html">f_close
</a>,
<a href=
"sfile.html">FIL
</a></tt></p>
63 <p class=
"foot"><a href=
"../00index_j.html">戻る
</a></p>