fatfs/doc/ja/read.html

   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=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/read.html">
   8 <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_read</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_read</h2>
  16 <p>ファイルからデータを読み出します。</p>
  17 <pre>
  18 FRESULT f_read (
  19   FIL* <span class="arg">fp</span>,     <span class="c">/* [IN] ファイル オブジェクト構造体 */</span>
  20   void* <span class="arg">buff</span>,  <span class="c">/* [OUT] 読み出したデータを格納するバッファ */</span>
  21   UINT <span class="arg">btr</span>,    <span class="c">/* [IN] 読み出すバイト数 */</span>
  22   UINT* <span class="arg">br</span>     <span class="c">/* [OUT] 読み出されたバイト数 */</span>
  23 );
  24 </pre>
  25 </div>
  26
  27 <div class="para arg">
  28 <h4>引数</h4>
  29 <dl class="par">
  30 <dt>fp</dt>
  31 <dd>ファイル オブジェクト構造体へのポインタを指定します。</dd>
  32 <dt>buff</dt>
  33 <dd>読み出したデータを格納するバッファを指すポインタを指定します。</dd>
  34 <dt>btr</dt>
  35 <dd>読み出すバイト数(0～<tt>UINT</tt>型の最大値)を指定します。</dd>
  36 <dt>br</dt>
  37 <dd>実際に読み出されたバイト数を格納する変数を指すポインタを指定します。戻り値は関数の成否にかかわらず常に有効です。</dd>
  38 </dl>
  39 </div>
  40
  41
  42 <div class="para ret">
  43 <h4>戻り値</h4>
  44 <p>
  45 <a href="rc.html#ok">FR_OK</a>,
  46 <a href="rc.html#de">FR_DISK_ERR</a>,
  47 <a href="rc.html#ie">FR_INT_ERR</a>,
  48 <a href="rc.html#de">FR_DENIED</a>,
  49 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  50 <a href="rc.html#tm">FR_TIMEOUT</a>
  51 </p>
  52 </div>
  53
  54
  55 <div class="para desc">
  56 <h4>解説</h4>
  57 <p>読み込み開始位置は、現在のリード/ライト ポインタからになります。リード/ライト ポインタは読み込まれたバイト数だけ進みます。関数が正常終了した後は、<tt class="arg">*br</tt>の値をチェックすべきです。<tt class="arg">*br</tt>が<tt class="arg">btr</tt>よりも小さいときは、読み込み中にファイルの終端に達したことを示しています。</p>
  58 </div>
  59
  60
  61 <div class="para comp">
  62 <h4>対応情報</h4>
  63 <p>全ての構成で使用可能です。</p>
  64 </div>
  65
  66
  67 <div class="para ref">
  68 <h4>参照</h4>
  69 <p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>
  70 </div>
  71
  72 <p class="foot"><a href="../00index_j.html">戻る</a></p>
  73 </body>
  74 </html>