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>有効なディレクトリ オブジェクト構造体へのポインタを指定します。</dd>
  30 <dt>fno</dt>
  31 <dd>読み出したディレクトリ項目を格納するファイル情報構造体へのポインタを指定します。</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#nr">FR_NOT_READY</a>,
  43 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  44 <a href="rc.html#tm">FR_TIMEOUT</a>,
  45 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  46 </p>
  47 </div>
  48
  49
  50 <div class="para desc">
  51 <h4>解説</h4>
  52 <p>ディレクトリの項目(ファイルとディレクトリ)を順次読み出します。この関数を繰り返し実行することによりそのディレクトリの全ての項目を読み出すことができます。得られるファイル情報の詳細については <tt>FILINFO</tt>構造体を参照してください。全ての項目が読み出され、読み出す項目がもう無いときは、<tt>fname[]</tt>メンバにヌル文字列が返されます。<tt class="arg">fno</tt>にヌル ポインタを指定すると、そのディレクトリのリード インデックスを先頭に巻き戻します。また、この関数は次に示すように関連する構成オプションにより動作が変わります。</p>
  53 <p>ドット エントリ("."、"..")は、相対パスが有効なとき(<tt>_FS_RPATH &gt;= 1</tt>)にのみ出力に現れます。</p>
  54 <p>LFN機能が有効な時は、この関数の呼び出しに先立って<tt>FILINFO</tt>構造体の<tt>lfname</tt>と<tt>lfsize</tt>が有効な値で初期化されていなければなりません。<tt>lfname</tt>はLFNを格納するバッファで、<tt>lfsize</tt>はそのバッファの要素数です。LFNを読み出す必要がないときは、<tt>lfname</tt>にヌル ポインタをセットしてください。次の条件に一つでも該当する場合は、LFN格納バッファにヌル文字列が返されます。</p>
  55 <ul>
  56 <li>ディレクトリ項目にLFN情報が存在しない。</li>
  57 <li>LFNの長さに対してLFN格納バッファまたはLFN操作バッファのサイズが不十分。</li>
  58 <li>LFNに現在のOEMコードに存在しない文字が含まれている。(非Unicode構成のとき)</li>
  59 </ul>
  60 <p>また、ディレクトリ項目にLFN情報が存在しない場合は、<tt>fname[]</tt>に英小文字が含まれる場合があります。</p>
  61 </div>
  62
  63
  64 <div class="para comp">
  65 <h4>対応情報</h4>
  66 <p><tt>_FS_MINIMIZE &lt;= 1</tt>のときに使用可能です。</p>
  67 </div>
  68
  69
  70 <div class="para use">
  71 <h4>使用例</h4>
  72 <pre>
  73 FRESULT scan_files (
  74     char* path        <span class="c">/* 開始ノード (ワークエリアとしても使用) */</span>
  75 )
  76 {
  77     FRESULT res;
  78     FILINFO fno;
  79     DIR dir;
  80     int i;
  81     char *fn;   <span class="c">/* 非Unicode構成を想定 */</span>
  82 <span class="k">#if</span> _USE_LFN
  83     static char lfn[_MAX_LFN + 1];
  84     fno.lfname = lfn;
  85     fno.lfsize = sizeof lfn;
  86 <span class="k">#endif</span>
  87
  88
  89     res = f_opendir(&amp;dir, path);                       <span class="c">/* ディレクトリを開く */</span>
  90     if (res == FR_OK) {
  91         i = strlen(path);
  92         for (;;) {
  93             res = f_readdir(&amp;dir, &amp;fno);                   <span class="c">/* ディレクトリ項目を1個読み出す */</span>
  94             if (res != FR_OK || fno.fname[0] == 0) break;  <span class="c">/* エラーまたは項目無しのときは抜ける */</span>
  95             if (fno.fname[0] == '.') continue;             <span class="c">/* ドットエントリは無視 */</span>
  96 <span class="k">#if</span> _USE_LFN
  97             fn = *fno.lfname ? fno.lfname : fno.fname;
  98 <span class="k">#else</span>
  99             fn = fno.fname;
 100 <span class="k">#endif</span>
 101             if (fno.fattrib &amp; AM_DIR) {                    <span class="c">/* ディレクトリ */</span>
 102                 sprintf(&amp;path[i], "/%s", fn);
 103                 res = scan_files(path);
 104                 path[i] = 0;
 105                 if (res != FR_OK) break;
 106             } else {                                       <span class="c">/* ファイル */</span>
 107                 printf("%s/%s\n", path, fn);
 108             }
 109         }
 110         f_closedir(&amp;dir);
 111     }
 112
 113     return res;
 114 }
 115 </pre>
 116 </div>
 117
 118
 119 <div class="para ref">
 120 <h4>参照</h4>
 121 <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>
 122 </div>
 123
 124 <p class="foot"><a href="../00index_j.html">戻る</a></p>
 125 </body>
 126 </html>