TheArchive/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2025-08-23 15:27:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

FatFs update to R0.11a.

Browse Source
This commit is contained in:
Jared Boone
2016-04-19 09:51:31 -07:00
parent ec75c00da2
commit 94c81528c1
118 changed files with 6365 additions and 5548 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
firmware/chibios-portapack/ext/fatfs/doc/en/readdir.html
View File

@@ -26,9 +26,9 @@ FRESULT f_readdir (
<h4>Parameters</h4>
<dl class="par">
<dt>dp</dt>
<dd>Pointer to the open directory object.</dd>
<dd>Pointer to the directory object created by <tt>f_opendir</tt> function.</dd>
<dt>fno</dt>
<dd>Pointer to the file information structure to store the read item.</dd>
<dd>Pointer to the file information structure to store the information about read item.</dd>
</dl>
</div>
@@ -39,7 +39,6 @@ FRESULT f_readdir (
<a href="rc.html#ok">FR_OK</a>,
<a href="rc.html#de">FR_DISK_ERR</a>,
<a href="rc.html#ie">FR_INT_ERR</a>,
<a href="rc.html#nr">FR_NOT_READY</a>,
<a href="rc.html#io">FR_INVALID_OBJECT</a>,
<a href="rc.html#tm">FR_TIMEOUT</a>,
<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
@@ -49,14 +48,13 @@ FRESULT f_readdir (
<div class="para desc">
<h4>Description</h4>
<p>The <tt>f_readdir()</tt> function reads directory items, file and directory, in sequence. All items in the directory can be read by calling <tt>f_readdir()</tt> function repeatedly. When relative path feature is enabled (<tt>_FS_RPATH &gt;= 1</tt>), dot entries ("." and "..") are not filtered out and they will appear in the read items. When all directory items have been read and no item to read, a null string is returned into the <tt>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>
<p>When LFN feature is enabled, <tt>lfname</tt> and <tt>lfsize</tt> in the file information structure must be initialized with valid value prior to use it. The <tt>lfname</tt> is a pointer to the LFN read buffer. The <tt>lfsize</tt> is size of the LFN read buffer in unit of <tt>TCHAR</tt>. If the LFN is not needed, set a null pointer to the <tt>lfname</tt> and the LFN is not returned. A null string will be returned into the LFN read buffer in case of following conditions.</p>
<p>The <tt>f_readdir</tt> function reads directory items, informations about file and directory, in sequence. All items in the directory can be read by calling <tt>f_readdir</tt> function repeatedly. When relative path feature is enabled (<tt><a href="config.html#fs_rpath">_FS_RPATH</a> &gt;= 1</tt>), dot entries (<tt>"."</tt> and <tt>".."</tt>) are not filtered out and they will appear in the read items. When all directory items have been read and no item to read, a null string is stored into the <tt>fno-&gt;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>
<p>When LFN feature is enabled, <tt>fno-&gt;lfname</tt> and <tt>fno-&gt;lfsize</tt> in the file information structure must be initialized with valid value prior to use it. The <tt>lfname</tt> points the LFN read buffer. The <tt>lfsize</tt> is size of the LFN read buffer in unit of <tt>TCHAR</tt>. If the LFN is not needed, set a null pointer to the <tt>lfname</tt> and the LFN is not returned. A null string will be returned into the LFN read buffer in case of following conditions.</p>
<ul>
<li>The directory item has no LFN information.</li>
<li>The directory item has no LFN information. In this case, lower case characters can be contained in the <tt>fname[]</tt>.</li>
<li>Either the size of read buffer or LFN working buffer is insufficient for the LFN.</li>
<li>The LFN contains any Unicode character that cannot be converted to OEM code. (not the case at Unicode API cfg.)</li>
<li>The LFN contains any Unicode character that cannot be converted to OEM code. (Not the case at Unicode API configuration)</li>
</ul>
<p>When the directory item has no LFN information, lower case characters can be contained in the <tt>fname[]</tt>.</p>
</div>