git.sur5r.net Git - freertos/blob - Demo/Common/FileSystem/FatFs-0.7e/doc/en/chdir.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_chdir</title>\r
   9 </head>\r
  10 \r
  11 <body>\r
  12 \r
  13 <div class="para">\r
  14 <h2>f_chdir</h2>\r
  15 <p>The f_chdir function changes the current directory of a drive.</p>\r
  16 <pre>\r
  17 FRESULT f_chdir (\r
  18   const XCHAR* <em>Path</em> /* Pointer to the path name */\r
  19 );\r
  20 </pre>\r
  21 </div>\r
  22 \r
  23 <div class="para">\r
  24 <h4>Parameters</h4>\r
  25 <dl class="par">\r
  26 <dt>Path</dt>\r
  27 <dd>Pointer to the null-terminated string that specifies a <a href="filename.html">directory</a> to go.</dd>\r
  28 </dl>\r
  29 </div>\r
  30 \r
  31 \r
  32 <div class="para">\r
  33 <h4>Return Values</h4>\r
  34 <dl class="ret">\r
  35 <dt>FR_OK (0)</dt>\r
  36 <dd>The function succeeded.</dd>\r
  37 <dt>FR_NO_PATH</dt>\r
  38 <dd>Could not find the path.</dd>\r
  39 <dt>FR_INVALID_NAME</dt>\r
  40 <dd>The path name is invalid.</dd>\r
  41 <dt>FR_INVALID_DRIVE</dt>\r
  42 <dd>The drive number is invalid.</dd>\r
  43 <dt>FR_NOT_READY</dt>\r
  44 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>\r
  45 <dt>FR_DISK_ERR</dt>\r
  46 <dd>The function failed due to an error in the disk function.</dd>\r
  47 <dt>FR_INT_ERR</dt>\r
  48 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>\r
  49 <dt>FR_NOT_ENABLED</dt>\r
  50 <dd>The logical drive has no work area.</dd>\r
  51 <dt>FR_NO_FILESYSTEM</dt>\r
  52 <dd>There is no valid FAT volume on the disk.</dd>\r
  53 </dl>\r
  54 </div>\r
  55 \r
  56 \r
  57 <div class="para">\r
  58 <h4>Description</h4>\r
  59 <p>The f_chdir function changes the current directory of the logical drive. The current directory of a drive is initialized to the root directory when the drive is auto-mounted. Note that the current directory is retained in the each file system object so that it also affects other tasks that using the drive.</p>\r
  60 </div>\r
  61 \r
  62 \r
  63 <div class="para">\r
  64 <h4>QuickInfo</h4>\r
  65 <p>Available when <tt>_FS_RPATH == 1</tt>.</p>\r
  66 </div>\r
  67 \r
  68 \r
  69 <div class="para">\r
  70 <h4>Example</h4>\r
  71 <pre>\r
  72     // Change current direcoty of the current drive (dir1 under root dir)\r
  73     f_chdir("/dir1");\r
  74 \r
  75     // Change current direcoty of drive 2 (parent dir)\r
  76     f_chdir("2:..");\r
  77 </pre>\r
  78 </div>\r
  79 \r
  80 <div class="para">\r
  81 <h4>See Also</h4>\r
  82 <p><tt><a href="chdrive.html">f_chdrive</a></tt></p>\r
  83 </div>\r
  84 \r
  85 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
  86 </body>\r
  87 </html>\r