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