closedir.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/close.html"> 8 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 9 <title>FatFs - f_closedir</title> 10 </head> 11 12 <body> 13 14 <div class="para func"> 15 <h2>f_closedir</h2> 16 <p>The f_closedir function closes an open directory.</p> 17 <pre> 18 FRESULT f_closedir ( 19 DIR* <span class="arg">dp</span> <span class="c">/* [IN] Pointer to the directory object */</span> 20 ); 21 </pre> 22 </div> 23 24 <div class="para arg"> 25 <h4>Parameter</h4> 26 <dl class="par"> 27 <dt>dp</dt> 28 <dd>Pointer to the open directory object structure to be closed.</dd> 29 </dl> 30 </div> 31 32 33 <div class="para ret"> 34 <h4>Return Values</h4> 35 <p> 36 <a href="rc.html#ok">FR_OK</a>, 37 <a href="rc.html#ie">FR_INT_ERR</a>, 38 <a href="rc.html#io">FR_INVALID_OBJECT</a>, 39 <a href="rc.html#tm">FR_TIMEOUT</a> 40 </p> 41 </div> 42 43 44 <div class="para desc"> 45 <h4>Description</h4> 46 <p>The <tt>f_closedir</tt> function closes an open directory object. After the function succeeded, the directory object is no longer valid and it can be discarded.</p> 47 <p>Note that the directory object can also be discarded without this procedure when option <tt>FF_FS_LOCK</tt> is not enabled. However this is not recommended for future compatibility.</p> 48 </div> 49 50 51 <div class="para comp"> 52 <h4>QuickInfo</h4> 53 <p>Available when <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> <= 1</tt>.</p> 54 </div> 55 56 57 <div class="para ref"> 58 <h4>See Also</h4> 59 <p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p> 60 </div> 61 62 <p class="foot"><a href="../00index_e.html">Return</a></p> 63 </body> 64 </html>