Merge branch 'chan-fatfs' into fatfs-integration

[z180-stamp.git] / fatfs / doc / ja / readdir.html

diff --git a/fatfs/doc/ja/readdir.html b/fatfs/doc/ja/readdir.html
index fc8fc5c6f16a2cee06dd65e95ce4d16f428aec1a..5305b0a3e776327d8fd6e7fc6ccccb11808e17ca 100644 (file)
--- a/fatfs/doc/ja/readdir.html
+++ b/fatfs/doc/ja/readdir.html
@@ -26,9 +26,9 @@ FRESULT f_readdir (
 <h4>引数</h4>\r
 <dl class="par">\r
 <dt>dp</dt>\r
-<dd>有効なディレクトリ オブジェクト構造体へのポインタを指定します。</dd>\r
+<dd><tt>f_opendir</tt>関数で作成された有効なディレクトリ オブジェクトへのポインタを指定します。</dd>\r
 <dt>fno</dt>\r
-<dd>読み出したディレクトリ項目を格納するファイル情報構造体へのポインタを指定します。</dd>\r
+<dd>読み出したディレクトリ項目を格納する<a href="sfileinfo.html">ファイル情報構造体</a>へのポインタ、またはヌル ポインタを指定します。</dd>\r
 </dl>\r
 </div>\r
 \r
@@ -39,7 +39,6 @@ FRESULT f_readdir (
 <a href="rc.html#ok">FR_OK</a>,\r
 <a href="rc.html#de">FR_DISK_ERR</a>,\r
 <a href="rc.html#ie">FR_INT_ERR</a>,\r
-<a href="rc.html#nr">FR_NOT_READY</a>,\r
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r
 <a href="rc.html#tm">FR_TIMEOUT</a>,\r
 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>\r
@@ -49,18 +48,16 @@ FRESULT f_readdir (
 \r
 <div class="para desc">\r
 <h4>解説</h4>\r
-<p>ディレクトリの項目(ファイルとディレクトリ)を順次読み出します。この関数を繰り返し実行することによりそのディレクトリの全ての項目を読み出すことができます。得られるファイル情報の詳細については <tt>FILINFO</tt>構造体を参照してください。全ての項目が読み出され、読み出す項目がもう無いときは、<tt>fname[]</tt>メンバにヌル文字列が返されます。<tt class="arg">fno</tt>にヌル ポインタを指定すると、そのディレクトリのリード インデックスを先頭に巻き戻します。また、この関数は次に示すように関連する構成オプションにより動作が変わります。</p>\r
-<p>ドット エントリ("."、"..")は、相対パスが有効なとき(<tt>_FS_RPATH &gt;= 1</tt>)にのみ出力に現れます。</p>\r
-<p>LFN機能が有効な時は、この関数の呼び出しに先立って<tt>FILINFO</tt>構造体の<tt>lfname</tt>と<tt>lfsize</tt>が有効な値で初期化されていなければなりません。<tt>lfname</tt>はLFNを格納するバッファで、<tt>lfsize</tt>はそのバッファの要素数です。LFNを読み出す必要がないときは、<tt>lfname</tt>にヌル ポインタをセットしてください。次の条件に一つでも該当する場合は、LFN格納バッファにヌル文字列が返されます。</p>\r
+<p>ディレクトリの項目(ファイルおよびサブ ディレクトリ)の情報を順次読み出します。この関数を繰り返し実行することによりそのディレクトリの全ての項目を読み出すことができます。得られるファイル情報の詳細については <tt>FILINFO</tt>構造体を参照してください。全ての項目が読み出され、読み出す項目がもう無いときは、<tt>fno-&gt;fname[]</tt>にヌル文字列が返されます。<tt class="arg">fno</tt>にヌル ポインタを指定すると、そのディレクトリのリード インデックスを先頭に巻き戻します。サブ ディレクトリのドット エントリ(<tt>"."</tt>と<tt>".."</tt>)は、出力に現れません。</p>\r
+<p>LFN構成では、<tt>altname[]</tt>が新たに定義され、そのオブジェクトの短いファイル名がストアされます。次の条件のときは長いファイル名を返せないので<tt>fname[]</tt>に短いファイル名がストアされ、<tt>altname[]</tt>はヌル文字列になります。</p>\r
 <ul>\r
-<li>ã\83\87ã\82£ã\83¬ã\82¯ã\83\88ã\83ªé \85ç\9b®ã\81«LFNæ\83\85å ±ã\81\8cå­\98å\9c¨ã\81\97ã\81ªã\81\84ã\80\82</li>\r
-<li>LFNの長さに対してLFN格納バッファまたはLFN操作バッファのサイズが不十分。</li>\r
-<li>LFNに現在のOEMコードに存在しない文字が含まれている。(非Unicode構成のとき)</li>\r
+<li>ã\82ªã\83\96ã\82¸ã\82§ã\82¯ã\83\88ã\81\8cé\95·ã\81\84ã\83\95ã\82¡ã\82¤ã\83«å\90\8dã\82\92æ\8c\81ã\81£ã\81¦ã\81\84ã\81ªã\81\84ã\80\82(exFATã\83\9cã\83ªã\83¥ã\83¼ã\83 ã\81§ã\81¯è©²å½\93ã\81\9bã\81\9a)</li>\r
+<li><tt>_MAX_LFN</tt>の設定がその長いファイル名の長さに対して不十分 (<tt>_MAX_LFN == 255</tt>では該当せず)</li>\r
+<li>長いファイル名にANSI/OEMコードに無い文字が含まれている。(<tt>_LFN_UNICODE == 1</tt>では該当せず)</li>\r
 </ul>\r
-<p>また、ディレクトリ項目にLFN情報が存在しない場合は、<tt>fname[]</tt>に英小文字が含まれる場合があります。</p>\r
+<p>exFATボリュームのディレクトリを読み出すとき、構成によっては問題が発生します。exFATでは短いファイル名がサポートされません。つまり、上記の条件のとき代わりに返すファイル名が無いということです。このような場合は<tt>fname[]</tt>に"?"が返され、そのオブジェクトにアクセスできないことを示します。この問題を避けるには、FatFsの構成を<tt>_LFN_UNICODE = 1</tt>および<tt>_MAX_LFN = 255</tt>として長いファイル名に完全対応とする必要があります。</p>\r
 </div>\r
 \r
-\r
 <div class="para comp">\r
 <h4>対応情報</h4>\r
 <p><tt>_FS_MINIMIZE &lt;= 1</tt>のときに使用可能です。</p>\r
@@ -70,44 +67,50 @@ FRESULT f_readdir (
 <div class="para use">\r
 <h4>使用例</h4>\r
 <pre>\r
+FATFS fs;\r
+char buff[256];\r
+\r
 FRESULT scan_files (\r
     char* path        <span class="c">/* 開始ノード (ワークエリアとしても使用) */</span>\r
 )\r
 {\r
     FRESULT res;\r
-    FILINFO fno;\r
     DIR dir;\r
-    int i;\r
-    char *fn;   <span class="c">/* 非Unicode構成を想定 */</span>\r
-<span class="k">#if</span> _USE_LFN\r
-    static char lfn[_MAX_LFN + 1];\r
-    fno.lfname = lfn;\r
-    fno.lfsize = sizeof lfn;\r
-<span class="k">#endif</span>\r
+    UINT i;\r
+    static FILINFO fno;\r
 \r
 \r
     res = f_opendir(&amp;dir, path);                       <span class="c">/* ディレクトリを開く */</span>\r
     if (res == FR_OK) {\r
-        i = strlen(path);\r
         for (;;) {\r
             res = f_readdir(&amp;dir, &amp;fno);                   <span class="c">/* ディレクトリ項目を1個読み出す */</span>\r
             if (res != FR_OK || fno.fname[0] == 0) break;  <span class="c">/* エラーまたは項目無しのときは抜ける */</span>\r
-            if (fno.fname[0] == '.') continue;             <span class="c">/* ドットエントリは無視 */</span>\r
-<span class="k">#if</span> _USE_LFN\r
-            fn = *fno.lfname ? fno.lfname : fno.fname;\r
-<span class="k">#else</span>\r
-            fn = fno.fname;\r
-<span class="k">#endif</span>\r
             if (fno.fattrib &amp; AM_DIR) {                    <span class="c">/* ディレクトリ */</span>\r
-                sprintf(&amp;path[i], "/%s", fn);\r
-                res = scan_files(path);\r
-                path[i] = 0;\r
+                i = strlen(path);\r
+                sprintf(&amp;path[i], "/%s", fno.fname);\r
+                res = scan_files(path);                    <span class="c">/* 一つ下へ */</span>\r
                 if (res != FR_OK) break;\r
+                path[i] = 0;\r
             } else {                                       <span class="c">/* ファイル */</span>\r
-                printf("%s/%s\n", path, fn);\r
+                printf("%s/%s\n", path, fno.fname);\r
             }\r
         }\r
-        f_closedir(&amp;dir);\r
+        f_closedir(&amp;dir)\r
+    }\r
+\r
+    return res;\r
+}\r
+\r
+\r
+int main (void)\r
+{\r
+    FRESULT res;\r
+\r
+\r
+    res = f_mount(&amp;fs, "", 1);\r
+    if (res == FR_OK) {\r
+        strcpy(buff, "/");\r
+        res = scan_files(buff);\r
     }\r
 \r
     return res;\r