• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_closedir</title>
8</head>
9
10<body>
11
12<div class="para func">
13<h2>f_closedir</h2>
14<p>The f_closedir function closes an open directory.</p>
15<pre>
16FRESULT f_closedir (
17  DIR* <span class="arg">dp</span>     <span class="c">/* [IN] Pointer to the directory object */</span>
18);
19</pre>
20</div>
21
22<div class="para arg">
23<h4>Parameter</h4>
24<dl class="par">
25<dt>dp</dt>
26<dd>Pointer to the open directory object structure to be closed.</dd>
27</dl>
28</div>
29
30
31<div class="para ret">
32<h4>Return Values</h4>
33<p>
34<a href="rc.html#ok">FR_OK</a>,
35<a href="rc.html#ie">FR_INT_ERR</a>,
36<a href="rc.html#io">FR_INVALID_OBJECT</a>,
37<a href="rc.html#tm">FR_TIMEOUT</a>
38</p>
39</div>
40
41
42<div class="para desc">
43<h4>Description</h4>
44<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>
45<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>
46</div>
47
48
49<div class="para comp">
50<h4>QuickInfo</h4>
51<p>Available when <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> &lt;= 1</tt>.</p>
52</div>
53
54
55<div class="para ref">
56<h4>See Also</h4>
57<p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p>
58</div>
59
60
61<p class="foot"><a href="../00index_e.html">Return</a></p>
62</body>
63</html>
64