Import fatfs R0.13b

[z180-stamp.git] / fatfs / documents / doc / findfirst.html

diff --git a/fatfs/doc/en/findfirst.html b/fatfs/documents/doc/findfirst.html
similarity index 80%
rename from fatfs/doc/en/findfirst.html
rename to fatfs/documents/doc/findfirst.html
index 61670ae34559f767678affc734b2ec0ed81fdf4f..daa6de644c0c22a9d010a544f88adeb1721912a6 100644 (file)
--- a/fatfs/doc/en/findfirst.html
+++ b/fatfs/documents/doc/findfirst.html
@@ -30,7 +30,7 @@ FRESULT f_findfirst (
 <dt>dp</dt>\r
 <dd>Pointer to the blank directory object.</dd>\r
 <dt>fno</dt>\r
-<dd>Pointer to the file information structure to store the information about the found item.</dd>\r
+<dd>Pointer to the <a href="sfileinfo.html">file information structure</a> to store the information about the found item.</dd>\r
 <dt>path</dt>\r
 <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>\r
 <dt>pattern</dt>\r
@@ -61,19 +61,19 @@ FRESULT f_findfirst (
 \r
 <div class="para desc">\r
 <h4>Description</h4>\r
-<p>After the directory specified by <tt class="arg">path</tt> could be opened, it starts to search the directory for items with the name specified by <tt class="arg">pattern</tt>. If the first item is found, the information about the object is stored into the file information structure. For more information about file information structure, refer to <a href="readdir.html"><tt>f_readdir</tt></a> function.</p>\r
-<p>The matching pattern can contain wildcard characters (<tt>?</tt> and <tt>*</tt>). A <tt>?</tt> matches an any character and an <tt>*</tt> matches an any string in length of zero or longer. When support of long file name is enabled, only <tt>fname[]</tt> is tested at <tt>_USE_FIND == 1</tt> and also <tt>altname[]</tt> is tested at <tt>_USE_FIND == 2</tt>. In this revision, there are some differences listed below between FatFs and standard systems in matching condition.</p>\r
+<p>After the directory specified by <tt class="arg">path</tt> could be opened, it starts to search the directory for items with the name specified by <tt class="arg">pattern</tt>. If the first item is found, the information about the object is stored into the file information structure <tt class="arg">fno</tt>.</p>\r
+<p>The matching pattern can contain wildcard characters (<tt>?</tt> and <tt>*</tt>). A <tt>?</tt> matches an any character and an <tt>*</tt> matches an any string in length of zero or longer. When support of long file name is enabled, only <tt>fname[]</tt> is tested at <tt>FF_USE_FIND == 1</tt> and also <tt>altname[]</tt> is tested at <tt>FF_USE_FIND == 2</tt>. In this revision, there are some differences listed below between FatFs and standard systems in matching condition.</p>\r
 <ul>\r
 <li><tt>"*.*"</tt> never matches any name without extension while it matches any name with or without extension at the standard systems.</li>\r
-<li>Any patterns terminated with a period never matches any name while it matches any name without extensiton at the standard systems.</li>\r
-<li><a href="filename.html#case">DBCS extended characters</a> are compared in case-sensitive at LFN with non-Unicode configuration.</li>\r
+<li>Any pattern terminated with a period never matches any name while it matches any name without extensiton at the standard systems.</li>\r
+<li><a href="filename.html#case">DBCS extended characters</a> are compared in case-sensitive at LFN with ANSI/OEM API.</li>\r
 </ul>\r
 </div>\r
 \r
 \r
 <div class="para comp">\r
 <h4>QuickInfo</h4>\r
-<p>This is a wrapper function of <a href="opendir.html"><tt>f_opendir</tt></a> and <a href="readdir.html"><tt>f_readdir</tt></a> function. Available when <tt>_USE_FIND &gt;= 1</tt> and <tt>_FS_MINIMIZE &lt;= 1</tt>.</p>\r
+<p>This is a wrapper function of <a href="opendir.html"><tt>f_opendir</tt></a> and <a href="readdir.html"><tt>f_readdir</tt></a> function. Available when <tt><a href="config.html#use_find">FF_USE_FIND</a> &gt;= 1</tt> and <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> &lt;= 1</tt>.</p>\r
 </div>\r
 \r
 \r
@@ -82,18 +82,19 @@ FRESULT f_findfirst (
 <pre>\r
 <span class="c">/* Search a directory for objects and display it */</span>\r
 \r
-void find_image (void)\r
+void find_image_file (void)\r
 {\r
     FRESULT fr;     <span class="c">/* Return value */</span>\r
     DIR dj;         <span class="c">/* Directory search object */</span>\r
     FILINFO fno;    <span class="c">/* File information */</span>\r
 \r
-    fr = f_findfirst(&amp;dj, &amp;fno, "", "dsc*.jpg");  <span class="c">/* Start to search for photo files */</span>\r
+    fr = <em>f_findfirst</em>(&amp;dj, &amp;fno, "", "dsc*.jpg");  <span class="c">/* Start to search for photo files */</span>\r
 \r
     while (fr == FR_OK &amp;&amp; fno.fname[0]) {         <span class="c">/* Repeat while an item is found */</span>\r
         printf("%s\n", fno.fname);                <span class="c">/* Display the object name */</span>\r
         fr = f_findnext(&amp;dj, &amp;fno);               <span class="c">/* Search for next item */</span>\r
     }\r
+\r
     f_closedir(&amp;dj);\r
 }\r
 </pre>\r