+++ /dev/null
-<!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=iso-8859-1">\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/readdir.html">\r
-<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
-<title>FatFs - f_readdir</title>\r
-</head>\r
-\r
-<body>\r
-\r
-<div class="para func">\r
-<h2>f_readdir</h2>\r
-<p>The f_readdir function reads an item of the directory.</p>\r
-<pre>\r
-FRESULT f_readdir (\r
- DIR* <span class="arg">dp</span>, <span class="c">/* [IN] Directory object */</span>\r
- FILINFO* <span class="arg">fno</span> <span class="c">/* [OUT] File information structure */</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 open directory object or null pointer.</dd>\r
-<dt>fno</dt>\r
-<dd>Pointer to the <a href="sfileinfo.html">file information structure</a> to store the information about read item.</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#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
-</p>\r
-</div>\r
-\r
-\r
-<div class="para desc">\r
-<h4>Description</h4>\r
-<p>The <tt>f_readdir</tt> function reads a directory item, informations about the object. All items in the directory can be read in sequence by <tt>f_readdir</tt> function calls. Dot entries (<tt>"."</tt> and <tt>".."</tt>) in the sub-directory are filtered out and they will never appear in the read items. When all directory items have been read and no item to read, a nul string is stored into the <tt>fno->fname[]</tt> without any error. When a null pointer is given to the <tt class="arg">fno</tt>, the read index of the directory object is rewinded.</p>\r
-<p>When support of long file name (LFN) is enabled, a member <tt>altname[]</tt> is defined in the file information structure to store the short file name of the object. In case of the some conditions listed below, short file name is stored into the <tt>fname[]</tt> and <tt>altname[]</tt> has a null string.</p>\r
-<ul>\r
-<li>The item has no long file name. (Not the case at exFAT volume)</li>\r
-<li>Setting of <tt>_MAX_LFN</tt> is insufficient for the long file name. (Not the case at <tt>_MAX_LFN == 255</tt>)</li>\r
-<li>The long file name contains any character not allowed in ANSI/OEM code. (Not the case at <tt>_LFN_UNICODE == 1</tt>)</li>\r
-</ul>\r
-<p>There is a problem on reading a directory of exFAT volume. The exFAT does not support short file name. This means no name can be returned on the condition above. If it is the case, a "?" is returned as file name to indicate that the object is not accessible. To avoid this problem, configure FatFs <tt>_LFN_UNICODE = 1</tt> and <tt>_MAX_LFN = 255</tt> to support the full feature of LFN specification.</p>\r
-</div>\r
-\r
-\r
-<div class="para comp">\r
-<h4>QuickInfo</h4>\r
-<p>Available when <tt>_FS_MINIMIZE <= 1</tt>.</p>\r
-</div>\r
-\r
-\r
-<div class="para use">\r
-<h4>Sample Code</h4>\r
-<pre>\r
-FRESULT scan_files (\r
- char* path <span class="c">/* Start node to be scanned (***also used as work area***) */</span>\r
-)\r
-{\r
- FRESULT res;\r
- DIR dir;\r
- UINT i;\r
- static FILINFO fno;\r
-\r
-\r
- res = f_opendir(&dir, path); <span class="c">/* Open the directory */</span>\r
- if (res == FR_OK) {\r
- for (;;) {\r
- res = f_readdir(&dir, &fno); <span class="c">/* Read a directory item */</span>\r
- if (res != FR_OK || fno.fname[0] == 0) break; <span class="c">/* Break on error or end of dir */</span>\r
- if (fno.fattrib & AM_DIR) { <span class="c">/* It is a directory */</span>\r
- i = strlen(path);\r
- sprintf(&path[i], "/%s", fno.fname);\r
- res = scan_files(path); <span class="c">/* Enter the directory */</span>\r
- if (res != FR_OK) break;\r
- path[i] = 0;\r
- } else { <span class="c">/* It is a file. */</span>\r
- printf("%s/%s\n", path, fno.fname);\r
- }\r
- }\r
- f_closedir(&dir)\r
- }\r
-\r
- return res;\r
-}\r
-\r
-\r
-int main (void)\r
-{\r
- FATFS fs;\r
- FRESULT res;\r
- char buff[256];\r
-\r
-\r
- res = f_mount(&fs, "", 1);\r
- if (res == FR_OK) {\r
- strcpy(buff, "/");\r
- res = scan_files(buff);\r
- }\r
-\r
- return res;\r
-}\r
-</pre>\r
-</div>\r
-\r
-\r
-<div class="para ref">\r
-<h4>See Also</h4>\r
-<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>\r
-</div>\r
-\r
-<p class="foot"><a href="../00index_e.html">Return</a></p>\r
-</body>\r
-</html>\r
projects / z180-stamp.git / blobdiff