git.sur5r.net Git - freertos/blob - Demo/Common/FileSystem/FatFs-0.7e/doc/en/read.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_read</title>\r
   9 </head>\r
  10 \r
  11 <body>\r
  12 \r
  13 <div class="para">\r
  14 <h2>f_read</h2>\r
  15 <p>The f_read function reads data from a file.</p>\r
  16 <pre>\r
  17 FRESULT f_read (\r
  18   FIL* <em>FileObject</em>,    /* Pointer to the file object structure */\r
  19   void* <em>Buffer</em>,       /* Pointer to the buffer to store read data */\r
  20   UINT <em>ByteToRead</em>,    /* Number of bytes to read */\r
  21   UINT* <em>ByteRead</em>      /* Pointer to the variable to return number of bytes read */\r
  22 );\r
  23 </pre>\r
  24 </div>\r
  25 \r
  26 <div class="para">\r
  27 <h4>Parameters</h4>\r
  28 <dl class="par">\r
  29 <dt>FileObject</dt>\r
  30 <dd>Pointer to the open file object.</dd>\r
  31 <dt>Buffer</dt>\r
  32 <dd>Pointer to the buffer to store read data</dd>\r
  33 <dt>ByteToRead</dt>\r
  34 <dd>Number of bytes to read in range of UINT.</dd>\r
  35 <dt>ByteRead</dt>\r
  36 <dd>Pointer to the UINT variable to return number of bytes read. The value is always valid after the function call regardless of the result.</dd>\r
  37 </dl>\r
  38 </div>\r
  39 \r
  40 \r
  41 <div class="para">\r
  42 <h4>Return Values</h4>\r
  43 <dl class="ret">\r
  44 <dt>FR_OK (0)</dt>\r
  45 <dd>The function succeeded.</dd>\r
  46 <dt>FR_DENIED</dt>\r
  47 <dd>The function denied due to the file has been opened in non-read mode.</dd>\r
  48 <dt>FR_DISK_ERR</dt>\r
  49 <dd>The function failed due to an error in the disk function.</dd>\r
  50 <dt>FR_INT_ERR</dt>\r
  51 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>\r
  52 <dt>FR_NOT_READY</dt>\r
  53 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>\r
  54 <dt>FR_INVALID_OBJECT</dt>\r
  55 <dd>The file object is invalid.</dd>\r
  56 </dl>\r
  57 </div>\r
  58 \r
  59 \r
  60 <div class="para">\r
  61 <h4>Description</h4>\r
  62 <p>The file pointer of the file object increases in number of bytes read. After the function succeeded, <tt>*ByteRead</tt> should be checked to detect the end of file. In case of <tt>*ByteRead &lt; ByteToRead</tt>, it means the R/W pointer reached end of the file during read operation.</p>\r
  63 </div>\r
  64 \r
  65 \r
  66 <div class="para">\r
  67 <h4>QuickInfo</h4>\r
  68 <p>Always available.</p>\r
  69 </div>\r
  70 \r
  71 \r
  72 <div class="para">\r
  73 <h4>See Also</h4>\r
  74 <p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>\r
  75 </div>\r
  76 \r
  77 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
  78 </body>\r
  79 </html>\r