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