bertos/fs/fatfs/doc/en/mount.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
   2 <html lang="en">\r
   3 <head>\r
   4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
   5 <meta http-equiv="Content-Style-Type" content="text/css">\r
   6 <link rel="up" title="FatFs" href="../00index_e.html">\r
   7 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
   8 <title>FatFs - f_mount</title>\r
   9 </head>\r
  10 \r
  11 <body>\r
  12 \r
  13 <div class="para">\r
  14 <h2>f_mount</h2>\r
  15 <p>The f_mount fucntion registers/unregisters a work area to the FatFs module.</p>\r
  16 <pre>\r
  17 FRESULT f_mount (\r
  18   BYTE  <em>Drive</em>,              /* Logical drive number */\r
  19   FATFS*  <em>FileSystemObject</em>  /* Pointer to the work area */\r
  20 );\r
  21 </pre>\r
  22 </div>\r
  23 \r
  24 <div class="para">\r
  25 <h4>Parameters</h4>\r
  26 <dl class="par">\r
  27 <dt>Drive</dt>\r
  28 <dd>Logical drive number (0-9) to register/unregister the work area.</dd>\r
  29 <dt>FileSystemObject</dt>\r
  30 <dd>Pointer to the work area (file system object) to be registered.</dd>\r
  31 </dl>\r
  32 </div>\r
  33 \r
  34 <div class="para">\r
  35 <h4>Return Values</h4>\r
  36 <dl class="ret">\r
  37 <dt>FR_OK (0)</dt>\r
  38 <dd>The function succeeded.</dd>\r
  39 <dt>FR_INVALID_DRIVE</dt>\r
  40 <dd>The drive number is invalid.</dd>\r
  41 </dl>\r
  42 </div>\r
  43 \r
  44 \r
  45 <div class="para">\r
  46 <h4>Description</h4>\r
  47 <p>The f_mount function registers/unregisters a work area to the FatFs module. The work area must be given to the logical drive with this function prior to 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>\r
  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 or media change.</p>\r
  49 </div>\r
  50 \r
  51 \r
  52 <div class="para">\r
  53 <h4>References</h4>\r
  54 <p><tt><a href="sfatfs.html">FATFS</a></tt></p>\r
  55 </div>\r
  56 \r
  57 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
  58 </body>\r
  59 </html>\r