projects / z180-stamp.git / blame
| Commit | Line | Data |
|---|---|---|
| 53668523 L |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r |
| 2 | <html lang="ja">\r | |
| 3 | <head>\r | |
| 7b78a5a2 | 4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r |
| 53668523 L |
5 | <meta http-equiv="Content-Style-Type" content="text/css">\r |
| 6 | <link rel="up" title="FatFs" href="../00index_j.html">\r | |
| 7 | <link rel="alternate" hreflang="en" title="English" href="../en/gets.html">\r | |
| 8 | <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_gets</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_gets</h2>\r | |
| 7b78a5a2 | 16 | <p>ファイルから文字列を読み出します。</p>\r |
| 53668523 L |
17 | <pre>\r |
| 18 | TCHAR* f_gets (\r | |
| 7b78a5a2 L |
19 | TCHAR* <span class="arg">buff</span>, <span class="c">/* [OUT] バッファ */</span>\r |
| 20 | int <span class="arg">len</span>, <span class="c">/* [IN] バッファのサイズ */</span>\r | |
| 21 | FIL* <span class="arg">fp</span> <span class="c">/* [IN] ファイル オブジェクト */</span>\r | |
| 53668523 L |
22 | );\r |
| 23 | </pre>\r | |
| 24 | </div>\r | |
| 25 | \r | |
| 26 | <div class="para arg">\r | |
| 7b78a5a2 | 27 | <h4>引数</h4>\r |
| 53668523 L |
28 | <dl class="par">\r |
| 29 | <dt>buff</dt>\r | |
| 7b78a5a2 | 30 | <dd>文字列を読み出すバッファを指すポインタを指定します。</dd>\r |
| 53668523 | 31 | <dt>len</dt>\r |
| 7b78a5a2 | 32 | <dd>バッファのサイズを要素数で指定します。</dd>\r |
| 53668523 | 33 | <dt>fp</dt>\r |
| 7b78a5a2 | 34 | <dd>ファイル オブジェクト構造体へのポインタを指定します。</dd>\r |
| 53668523 L |
35 | </dl>\r |
| 36 | </div>\r | |
| 37 | \r | |
| 38 | \r | |
| 39 | <div class="para ret">\r | |
| 7b78a5a2 L |
40 | <h4>戻り値</h4>\r |
| 41 | <p>関数が成功すると<tt class="arg">buff</tt>が返されます。</p>\r | |
| 53668523 L |
42 | </div>\r |
| 43 | \r | |
| 44 | \r | |
| 45 | <div class="para desc">\r | |
| 7b78a5a2 | 46 | <h4>解説</h4>\r |
| 70702af1 | 47 | <p>読み出し動作は、最初の<tt>'\n'</tt>を読み込むか、ファイル終端に達するか、<tt class="arg">len</tt> - 1文字を読み出すまで続きます。読み込まれた文字列の終端には<tt>'\0'</tt>が付加されます。既にファイル終端で1文字も読み込まれなかったとき、または何らかのエラーが発生したときは関数は失敗しヌル ポインタを返します。ファイル終端かエラーかは<tt>f_eof/f_error</tt>関数で調べられます。</p>\r |
| 7b78a5a2 | 48 | <p>Unicode API構成(<tt>_LFN_UNICODE == 1</tt>)が選択されているときは、<tt class="arg">buff</tt>はUTF-16文字列になりますが、ファイル上のエンコードは、<tt>_STRF_ENCODE</tt>オプションで選択できます。それ以外の時は無変換(1バイト/1文字)で読み出します。</p>\r |
| 53668523 L |
49 | </div>\r |
| 50 | \r | |
| 51 | \r | |
| 52 | <div class="para comp">\r | |
| 7b78a5a2 | 53 | <h4>対応情報</h4>\r |
| 70702af1 | 54 | <p>この関数は<a href="read.html"><tt>f_read</tt></a>関数のラッパー関数です。<tt>_USE_STRFUNC</tt>が1または2のとき使用可能です。2のときは、ファイルに含まれる<tt>'\r'</tt>が取り除かれてバッファに読み込まれます。</p>\r |
| 53668523 L |
55 | </div>\r |
| 56 | \r | |
| 57 | \r | |
| 58 | <div class="para ref">\r | |
| 7b78a5a2 | 59 | <h4>参照</h4>\r |
| 53668523 L |
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>\r |
| 61 | </div>\r | |
| 62 | \r | |
| 7b78a5a2 | 63 | <p class="foot"><a href="../00index_j.html">戻る</a></p>\r |
| 53668523 L |
64 | </body>\r |
| 65 | </html>\r |