]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/opendir.html
Import fatfs R0.10b
[z180-stamp.git] / fatfs / doc / en / opendir.html
diff --git a/fatfs/doc/en/opendir.html b/fatfs/doc/en/opendir.html
new file mode 100644 (file)
index 0000000..2fd4e45
--- /dev/null
@@ -0,0 +1,75 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
+<html lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Style-Type" content="text/css">\r
+<link rel="up" title="FatFs" href="../00index_e.html">\r
+<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/opendir.html">\r
+<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
+<title>FatFs - f_opendir</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<div class="para func">\r
+<h2>f_opendir</h2>\r
+<p>The f_opendir function opens a directory.</p>\r
+<pre>\r
+FRESULT f_opendir (\r
+  DIR* <span class="arg">dp</span>,           <span class="c">/* [OUT] Pointer to the directory object structure */</span>\r
+  const TCHAR* <span class="arg">path</span>  <span class="c">/* [IN] Directory name */</span>\r
+);\r
+</pre>\r
+</div>\r
+\r
+<div class="para arg">\r
+<h4>Parameters</h4>\r
+<dl class="par">\r
+<dt>dp</dt>\r
+<dd>Pointer to the blank directory object to create a new one.</dd>\r
+<dt>path</dt>\r
+<dd>Pinter to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>\r
+</dl>\r
+</div>\r
+\r
+\r
+<div class="para ret">\r
+<h4>Return Values</h4>\r
+<p>\r
+<a href="rc.html#ok">FR_OK</a>,\r
+<a href="rc.html#de">FR_DISK_ERR</a>,\r
+<a href="rc.html#ie">FR_INT_ERR</a>,\r
+<a href="rc.html#nr">FR_NOT_READY</a>,\r
+<a href="rc.html#np">FR_NO_PATH</a>,\r
+<a href="rc.html#in">FR_INVALID_NAME</a>,\r
+<a href="rc.html#io">FR_INVALID_OBJECT</a>,\r
+<a href="rc.html#id">FR_INVALID_DRIVE</a>,\r
+<a href="rc.html#ne">FR_NOT_ENABLED</a>,\r
+<a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r
+<a href="rc.html#tm">FR_TIMEOUT</a>,\r
+<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>,\r
+<a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a>\r
+</p>\r
+</div>\r
+\r
+\r
+<div class="para desc">\r
+<h4>Description</h4>\r
+<p>The <tt>f_opendir()</tt> function opens an exsisting directory and creates a directory object for subsequent <tt>f_readdir()</tt> function.</p>\r
+</div>\r
+\r
+\r
+<div class="para comp">\r
+<h4>QuickInfo</h4>\r
+<p>Available when <tt>_FS_MINIMIZE &lt;= 1</tt>.</p>\r
+</div>\r
+\r
+\r
+<div class="para ref">\r
+<h4>See Also</h4>\r
+<p><tt><a href="readdir.html">f_readdir</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a></tt></p>\r
+</div>\r
+\r
+<p class="foot"><a href="../00index_e.html">Return</a></p>\r
+</body>\r
+</html>\r