fatfs/doc/ja/readdir.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/readdir.html">
   8 <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_readdir</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_readdir</h2>
  16 <p>ディレクトリ項目を読み出します。</p>
  17 <pre>
  18 FRESULT f_readdir (
  19   DIR* <span class="arg">dp</span>,      <span class="c">/* [IN] ディレクトリ ブジェクト構造体へのポインタ */</span>
  20   FILINFO* <span class="arg">fno</span>  <span class="c">/* [OUT] ファイル情報構造体へのポインタ */</span>
  21 );
  22 </pre>
  23 </div>
  24
  25 <div class="para arg">
  26 <h4>引数</h4>
  27 <dl class="par">
  28 <dt>dp</dt>
  29 <dd><tt>f_opendir</tt>関数で作成された有効なディレクトリ オブジェクトへのポインタを指定します。</dd>
  30 <dt>fno</dt>
  31 <dd>読み出したディレクトリ項目を格納する<a href="sfileinfo.html">ファイル情報構造体</a>へのポインタ、またはヌル ポインタを指定します。</dd>
  32 </dl>
  33 </div>
  34
  35
  36 <div class="para ret">
  37 <h4>戻り値</h4>
  38 <p>
  39 <a href="rc.html#ok">FR_OK</a>,
  40 <a href="rc.html#de">FR_DISK_ERR</a>,
  41 <a href="rc.html#ie">FR_INT_ERR</a>,
  42 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  43 <a href="rc.html#tm">FR_TIMEOUT</a>,
  44 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  45 </p>
  46 </div>
  47
  48
  49 <div class="para desc">
  50 <h4>解説</h4>
  51 <p>ディレクトリの項目(ファイルおよびサブ ディレクトリ)の情報を順次読み出します。この関数を繰り返し実行することによりそのディレクトリの全ての項目を読み出すことができます。得られるファイル情報の詳細については <tt>FILINFO</tt>構造体を参照してください。全ての項目が読み出され、読み出す項目がもう無いときは、<tt>fno-&gt;fname[]</tt>にヌル文字列が返されます。<tt class="arg">fno</tt>にヌル ポインタを指定すると、そのディレクトリのリード インデックスを先頭に巻き戻します。サブ ディレクトリのドット エントリ(<tt>"."</tt>と<tt>".."</tt>)は、出力に現れません。</p>
  52 <p>LFN構成では、<tt>altname[]</tt>が新たに定義され、そのオブジェクトの短いファイル名がストアされます。次の条件のときは長いファイル名を返せないので<tt>fname[]</tt>に短いファイル名がストアされ、<tt>altname[]</tt>はヌル文字列になります。</p>
  53 <ul>
  54 <li>オブジェクトが長いファイル名を持っていない。(exFATボリュームでは該当せず)</li>
  55 <li><tt>_MAX_LFN</tt>の設定がその長いファイル名の長さに対して不十分 (<tt>_MAX_LFN == 255</tt>では該当せず)</li>
  56 <li>長いファイル名にANSI/OEMコードに無い文字が含まれている。(<tt>_LFN_UNICODE == 1</tt>では該当せず)</li>
  57 </ul>
  58 <p>exFATボリュームのディレクトリを読み出すとき、構成によっては問題が発生します。exFATでは短いファイル名がサポートされません。つまり、上記の条件のとき代わりに返すファイル名が無いということです。このような場合は<tt>fname[]</tt>に"?"が返され、そのオブジェクトにアクセスできないことを示します。この問題を避けるには、FatFsの構成を<tt>_LFN_UNICODE = 1</tt>および<tt>_MAX_LFN = 255</tt>として長いファイル名に完全対応とする必要があります。</p>
  59 </div>
  60
  61 <div class="para comp">
  62 <h4>対応情報</h4>
  63 <p><tt>_FS_MINIMIZE &lt;= 1</tt>のときに使用可能です。</p>
  64 </div>
  65
  66
  67 <div class="para use">
  68 <h4>使用例</h4>
  69 <pre>
  70 FATFS fs;
  71 char buff[256];
  72
  73 FRESULT scan_files (
  74     char* path        <span class="c">/* 開始ノード (ワークエリアとしても使用) */</span>
  75 )
  76 {
  77     FRESULT res;
  78     DIR dir;
  79     UINT i;
  80     static FILINFO fno;
  81
  82
  83     res = f_opendir(&amp;dir, path);                       <span class="c">/* ディレクトリを開く */</span>
  84     if (res == FR_OK) {
  85         for (;;) {
  86             res = f_readdir(&amp;dir, &amp;fno);                   <span class="c">/* ディレクトリ項目を1個読み出す */</span>
  87             if (res != FR_OK || fno.fname[0] == 0) break;  <span class="c">/* エラーまたは項目無しのときは抜ける */</span>
  88             if (fno.fattrib &amp; AM_DIR) {                    <span class="c">/* ディレクトリ */</span>
  89                 i = strlen(path);
  90                 sprintf(&amp;path[i], "/%s", fno.fname);
  91                 res = scan_files(path);                    <span class="c">/* 一つ下へ */</span>
  92                 if (res != FR_OK) break;
  93                 path[i] = 0;
  94             } else {                                       <span class="c">/* ファイル */</span>
  95                 printf("%s/%s\n", path, fno.fname);
  96             }
  97         }
  98         f_closedir(&amp;dir)
  99     }
 100
 101     return res;
 102 }
 103
 104
 105 int main (void)
 106 {
 107     FRESULT res;
 108
 109
 110     res = f_mount(&amp;fs, "", 1);
 111     if (res == FR_OK) {
 112         strcpy(buff, "/");
 113         res = scan_files(buff);
 114     }
 115
 116     return res;
 117 }
 118 </pre>
 119 </div>
 120
 121
 122 <div class="para ref">
 123 <h4>参照</h4>
 124 <p><tt><a href="opendir.html">f_opendir</a>, <a href="closedir.html">f_closedir</a>, <a href="stat.html">f_stat</a>, <a href="sfileinfo.html">FILINFO</a>, <a href="sdir.html">DIR</a></tt></p>
 125 </div>
 126
 127 <p class="foot"><a href="../00index_j.html">戻る</a></p>
 128 </body>
 129 </html>