FreeRTOS/Common/FileSystem/FatFs-0.7e/doc/en/chdrive.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_chdrive</title>
   9 </head>
  10
  11 <body>
  12
  13 <div class="para">
  14 <h2>f_chdrive</h2>
  15 <p>The f_chdrive function changes the current drive.</p>
  16 <pre>
  17 FRESULT f_chdrive (
  18   BYTE <em>Drive</em> /* Logical drive number */
  19 );
  20 </pre>
  21 </div>
  22
  23 <div class="para">
  24 <h4>Parameters</h4>
  25 <dl class="par">
  26 <dt>Drive</dt>
  27 <dd>Specifies the <a href="filename.html">logical drive number</a> to be set as the current drive.</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_INVALID_DRIVE</dt>
  38 <dd>The drive number is invalid.</dd>
  39 </dl>
  40 </div>
  41
  42
  43 <div class="para">
  44 <h4>Description</h4>
  45 <p>The f_chdrive function changes the current drive. The initial value of the current drive number is 0. Note that the current drive is retained in a static variable so that it also affects other tasks that using the file functions.</p>
  46 </div>
  47
  48 <div class="para">
  49 <h4>QuickInfo</h4>
  50 <p>Available when <tt>_FS_RPATH == 1</tt>.</p>
  51 </div>
  52
  53
  54 <div class="para">
  55 <h4>See Also</h4>
  56 <p><tt><a href="chdir.html">f_chdir</a></tt></p>
  57 </div>
  58
  59 <p class="foot"><a href="../00index_e.html">Return</a></p>
  60 </body>
  61 </html>