gets.html 2.6 KB

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