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