]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/findfirst.html
Import fatfs R0.13b
[z180-stamp.git] / fatfs / doc / en / findfirst.html
diff --git a/fatfs/doc/en/findfirst.html b/fatfs/doc/en/findfirst.html
deleted file mode 100644 (file)
index 61670ae..0000000
+++ /dev/null
@@ -1,110 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
-<html lang="en">\r
-<head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
-<meta http-equiv="Content-Style-Type" content="text/css">\r
-<link rel="up" title="FatFs" href="../00index_e.html">\r
-<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/findfirst.html">\r
-<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
-<title>FatFs - f_findfirst</title>\r
-</head>\r
-\r
-<body>\r
-\r
-<div class="para func">\r
-<h2>f_findfirst</h2>\r
-<p>The f_findfirst function searches a directroy for an item.</p>\r
-<pre>\r
-FRESULT f_findfirst (\r
-  DIR* <span class="arg">dp</span>,              <span class="c">/* [OUT] Poninter to the directory object */</span>\r
-  FILINFO* <span class="arg">fno</span>,         <span class="c">/* [OUT] Pointer to the file information structure */</span>\r
-  const TCHAR* <span class="arg">path</span>,    <span class="c">/* [IN] Pointer to the directory name to be opened */</span>\r
-  const TCHAR* <span class="arg">pattern</span>  <span class="c">/* [IN] Pointer to the matching pattern string */</span>\r
-);\r
-</pre>\r
-</div>\r
-\r
-<div class="para arg">\r
-<h4>Parameters</h4>\r
-<dl class="par">\r
-<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
-<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
-<dd>Pointer to the nul-terminated string that specifies the name matching pattern to be searched for. It is referred by also subsequent <tt>f_findnext</tt> function, so that the string must be valid while the successive function calls.</dd>\r
-</dl>\r
-</div>\r
-\r
-\r
-<div class="para ret">\r
-<h4>Return Values</h4>\r
-<p>\r
-<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#np">FR_NO_PATH</a>,\r
-<a href="rc.html#in">FR_INVALID_NAME</a>,\r
-<a href="rc.html#io">FR_INVALID_OBJECT</a>,\r
-<a href="rc.html#id">FR_INVALID_DRIVE</a>,\r
-<a href="rc.html#ne">FR_NOT_ENABLED</a>,\r
-<a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r
-<a href="rc.html#tm">FR_TIMEOUT</a>,\r
-<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>,\r
-<a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a>\r
-</p>\r
-</div>\r
-\r
-\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
-<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
-</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
-</div>\r
-\r
-\r
-<div class="para use">\r
-<h4>Examples</h4>\r
-<pre>\r
-<span class="c">/* Search a directory for objects and display it */</span>\r
-\r
-void find_image (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
-\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
-    f_closedir(&amp;dj);\r
-}\r
-</pre>\r
-</div>\r
-\r
-\r
-<div class="para ref">\r
-<h4>See Also</h4>\r
-<p><tt><a href="findnext.html">f_findnext</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>\r
-</div>\r
-\r
-<p class="foot"><a href="../00index_e.html">Return</a></p>\r
-</body>\r
-</html>\r