FreeRTOS/Common/FileSystem/FatFs-0.7e/doc/en/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=iso-8859-1">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <link rel="up" title="FatFs" href="../00index_e.html">
   7 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   8 <title>FatFs - f_opendir</title>
   9 </head>
  10
  11 <body>
  12
  13 <div class="para">
  14 <h2>f_opendir</h2>
  15 <p>The f_opendir function opens a directory.</p>
  16 <pre>
  17 FRESULT f_opendir (
  18   DIR* <em>DirObject</em>,       /* Pointer to the blank directory object structure */
  19   const XCHAR* <em>DirName</em>  /* Pointer to the directory name */
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para">
  25 <h4>Parameters</h4>
  26 <dl class="par">
  27 <dt>DirObject</dt>
  28 <dd>Pointer to the blank directory object to be created.</dd>
  29 <dt>DirName</dt>
  30 <dd>Pinter to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>
  31 </dl>
  32 </div>
  33
  34
  35 <div class="para">
  36 <h4>Return Values</h4>
  37 <dl class="ret">
  38 <dt>FR_OK (0)</dt>
  39 <dd>The function succeeded and the directory object is created. It is used for subsequent calls to read the directory entries.</dd>
  40 <dt>FR_NO_PATH</dt>
  41 <dd>Could not find the path.</dd>
  42 <dt>FR_INVALID_NAME</dt>
  43 <dd>The path name is invalid.</dd>
  44 <dt>FR_INVALID_DRIVE</dt>
  45 <dd>The drive number is invalid.</dd>
  46 <dt>FR_NOT_READY</dt>
  47 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
  48 <dt>FR_DISK_ERR</dt>
  49 <dd>The function failed due to an error in the disk function.</dd>
  50 <dt>FR_INT_ERR</dt>
  51 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>
  52 <dt>FR_NOT_ENABLED</dt>
  53 <dd>The logical drive has no work area.</dd>
  54 <dt>FR_NO_FILESYSTEM</dt>
  55 <dd>There is no valid FAT volume on the disk.</dd>
  56 </dl>
  57 </div>
  58
  59
  60 <div class="para">
  61 <h4>Description</h4>
  62 <p>The f_opendir function opens an exsisting directory and creates the directory object for subsequent calls. The directory object structure can be discarded at any time without any procedure.</p>
  63 </div>
  64
  65
  66 <div class="para">
  67 <h4>QuickInfo</h4>
  68 <p>Available when <tt>_FS_MINIMIZE &lt;= 1</tt>.</p>
  69 </div>
  70
  71
  72 <div class="para">
  73 <h4>See Also</h4>
  74 <p><tt><a href="readdir.html">f_readdir</a>, <a href="sdir.html">DIR</a></tt></p>
  75 </div>
  76
  77 <p class="foot"><a href="../00index_e.html">Return</a></p>
  78 </body>
  79 </html>