FreeRTOS/Common/FileSystem/FatFs-0.7e/doc/en/mount.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_mount</title>
   9 </head>
  10
  11 <body>
  12
  13 <div class="para">
  14 <h2>f_mount</h2>
  15 <p>The f_mount fucntion registers/unregisters a work area to the FatFs module.</p>
  16 <pre>
  17 FRESULT f_mount (
  18   BYTE  <em>Drive</em>,              /* Logical drive number */
  19   FATFS*  <em>FileSystemObject</em>  /* Pointer to the work area */
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para">
  25 <h4>Parameters</h4>
  26 <dl class="par">
  27 <dt>Drive</dt>
  28 <dd>Logical drive number (0-9) to register/unregister the work area.</dd>
  29 <dt>FileSystemObject</dt>
  30 <dd>Pointer to the work area (file system object) to be registered.</dd>
  31 </dl>
  32 </div>
  33
  34 <div class="para">
  35 <h4>Return Values</h4>
  36 <dl class="ret">
  37 <dt>FR_OK (0)</dt>
  38 <dd>The function succeeded.</dd>
  39 <dt>FR_INVALID_DRIVE</dt>
  40 <dd>The drive number is invalid.</dd>
  41 </dl>
  42 </div>
  43
  44
  45 <div class="para">
  46 <h4>Description</h4>
  47 <p>The f_mount function registers/unregisters a work area to the FatFs module. The work area must be given to the each volume with this function prior to use any other file function. To unregister a work area, specify a NULL to the <em>FileSystemObject</em>, and then the work area can be discarded.</p>
  48 <p>This function only initializes the given work area and registers its address to the internal table, any access to the disk I/O layer does not occure. The volume mount process is performed on first file access after f_mount function or media change.</p>
  49 </div>
  50
  51
  52 <div class="para">
  53 <h4>QuickInfo</h4>
  54 <p>Always available.</p>
  55 </div>
  56
  57
  58 <div class="para">
  59 <h4>See Also</h4>
  60 <p><tt><a href="sfatfs.html">FATFS</a></tt></p>
  61 </div>
  62
  63 <p class="foot"><a href="../00index_e.html">Return</a></p>
  64 </body>
  65 </html>