1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> 2<html lang="en"> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 5<meta http-equiv="Content-Style-Type" content="text/css"> 6<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 7<title>FatFs - f_opendir</title> 8</head> 9 10<body> 11 12<div class="para func"> 13<h2>f_opendir</h2> 14<p>The f_opendir function opens a directory.</p> 15<pre> 16FRESULT f_opendir ( 17 DIR* <span class="arg">dp</span>, <span class="c">/* [OUT] Pointer to the directory object structure */</span> 18 const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Directory name */</span> 19); 20</pre> 21</div> 22 23<div class="para arg"> 24<h4>Parameters</h4> 25<dl class="par"> 26<dt>dp</dt> 27<dd>Pointer to the blank directory object to create a new one. If a null pointer is given, the function fails with <tt>FR_INVALID_OBJECT</tt>.</dd> 28<dt>path</dt> 29<dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened. If a null pointer is given, the function fails with <tt>FR_INVALID_DRIVE</tt>.</dd> 30</dl> 31</div> 32 33 34<div class="para ret"> 35<h4>Return Values</h4> 36<p> 37<a href="rc.html#ok">FR_OK</a>, 38<a href="rc.html#de">FR_DISK_ERR</a>, 39<a href="rc.html#ie">FR_INT_ERR</a>, 40<a href="rc.html#nr">FR_NOT_READY</a>, 41<a href="rc.html#np">FR_NO_PATH</a>, 42<a href="rc.html#in">FR_INVALID_NAME</a>, 43<a href="rc.html#io">FR_INVALID_OBJECT</a>, 44<a href="rc.html#id">FR_INVALID_DRIVE</a>, 45<a href="rc.html#ne">FR_NOT_ENABLED</a>, 46<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, 47<a href="rc.html#tm">FR_TIMEOUT</a>, 48<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>, 49<a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a> 50</p> 51</div> 52 53 54<div class="para desc"> 55<h4>Description</h4> 56<p>The <tt>f_opendir</tt> function opens an exsisting directory and creates a directory object for subsequent <tt>f_readdir</tt> function.</p> 57</div> 58 59 60<div class="para comp"> 61<h4>QuickInfo</h4> 62<p>Available when <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> <= 1</tt>.</p> 63</div> 64 65 66<div class="para ref"> 67<h4>See Also</h4> 68<p><tt><a href="readdir.html">f_readdir</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a></tt></p> 69</div> 70 71 72<p class="foot"><a href="../00index_e.html">Return</a></p> 73</body> 74</html> 75