fatfs/documents/doc/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=utf-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <link rel="up" title="FatFs" href="../00index_e.html">
   7 <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/chdir.html">
   8 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_chdir</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_chdir</h2>
  16 <p>The <tt>f_chdir</tt> function changes the current directory of the logical drive.</p>
  17 <pre>
  18 FRESULT f_chdir (
  19   const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Path name */</span>
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para arg">
  25 <h4>Parameters</h4>
  26 <dl class="par">
  27 <dt>path</dt>
  28 <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory</a> to go.</dd>
  29 </dl>
  30 </div>
  31
  32
  33 <div class="para ret">
  34 <h4>Return Values</h4>
  35 <p>
  36 <a href="rc.html#ok">FR_OK</a>,
  37 <a href="rc.html#de">FR_DISK_ERR</a>,
  38 <a href="rc.html#ie">FR_INT_ERR</a>,
  39 <a href="rc.html#nr">FR_NOT_READY</a>,
  40 <a href="rc.html#np">FR_NO_PATH</a>,
  41 <a href="rc.html#in">FR_INVALID_NAME</a>,
  42 <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  43 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  44 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  45 <a href="rc.html#tm">FR_TIMEOUT</a>,
  46 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  47 </p>
  48 </div>
  49
  50
  51 <div class="para desc">
  52 <h4>Description</h4>
  53 <p>The <tt>f_chdir</tt> function changes the current directory of the logical drive. Also the current drive is changed at Unix style volume ID, <tt><a href="config.html#str_volume_id">FF_STR_VOLUME_ID</a> == 2</tt>. The current directory of each logical drive is initialized to the root directory on mount.</p>
  54 <p>Note that the current directory is retained in the each file system object and the current drive is retained in a static variable, so that it also affects other tasks that use the file functions.</p>
  55 </div>
  56
  57
  58 <div class="para comp">
  59 <h4>QuickInfo</h4>
  60 <p>Available when <tt><a href="config.html#fs_rpath">FF_FS_RPATH</a> &gt;= 1</tt>.</p>
  61 </div>
  62
  63
  64 <div class="para use">
  65 <h4>Example</h4>
  66 <pre>
  67     <span class="c">/* Change current direcoty of the current drive ("dir1" under root directory) */</span>
  68     <em>f_chdir</em>("/dir1");
  69
  70     <span class="c">/* Change current direcoty of current drive (parent directory of drive 2) */</span>
  71     <em>f_chdir</em>("2:..");
  72
  73     <span class="c">/* Change current direcoty of the drive "sdcard" (at DOS/Windows style volume ID) */</span>
  74     <em>f_chdir</em>("sdcard:/dir1");
  75
  76     <span class="c">/* Change current direcoty of the drive "flash" and set it as current drive (at Unix style volume ID) */</span>
  77     <em>f_chdir</em>("/flash/dir1");
  78 </pre>
  79 </div>
  80
  81 <div class="para ref">
  82 <h4>See Also</h4>
  83 <p><tt><a href="chdrive.html">f_chdrive</a>, <a href="getcwd.html">f_getcwd</a></tt></p>
  84 </div>
  85
  86 <p class="foot"><a href="../00index_e.html">Return</a></p>
  87 </body>
  88 </html>