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