--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
+<html lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Style-Type" content="text/css">\r
+<link rel="up" title="FatFs" href="../00index_e.html">\r
+<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/read.html">\r
+<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
+<title>FatFs - f_read</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<div class="para func">\r
+<h2>f_read</h2>\r
+<p>The f_read function reads data from a file.</p>\r
+<pre>\r
+FRESULT f_read (\r
+ FIL* <span class="arg">fp</span>, <span class="c">/* [IN] File object */</span>\r
+ void* <span class="arg">buff</span>, <span class="c">/* [OUT] Buffer to store read data */</span>\r
+ UINT <span class="arg">btr</span>, <span class="c">/* [IN] Number of bytes to read */</span>\r
+ UINT* <span class="arg">br</span> <span class="c">/* [OUT] Number of bytes read */</span>\r
+);\r
+</pre>\r
+</div>\r
+\r
+<div class="para arg">\r
+<h4>Parameters</h4>\r
+<dl class="par">\r
+<dt>fp</dt>\r
+<dd>Pointer to the open file object.</dd>\r
+<dt>buff</dt>\r
+<dd>Pointer to the buffer to store read data.</dd>\r
+<dt>btr</dt>\r
+<dd>Number of bytes to read in range of <tt>UINT</tt> type.</dd>\r
+<dt>br</dt>\r
+<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes read. The value is always valid after the function call regardless of the result.</dd>\r
+</dl>\r
+</div>\r
+\r
+\r
+<div class="para ret">\r
+<h4>Return Values</h4>\r
+<p>\r
+<a href="rc.html#ok">FR_OK</a>,\r
+<a href="rc.html#de">FR_DISK_ERR</a>,\r
+<a href="rc.html#ie">FR_INT_ERR</a>,\r
+<a href="rc.html#nr">FR_NOT_READY</a>,\r
+<a href="rc.html#io">FR_INVALID_OBJECT</a>,\r
+<a href="rc.html#tm">FR_TIMEOUT</a>\r
+</p>\r
+</div>\r
+\r
+\r
+<div class="para desc">\r
+<h4>Description</h4>\r
+<p>The file read/write pointer of the file object advances number of bytes read. After the function succeeded, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> is less than <tt class="arg">btr</tt>, it means the read/write pointer reached end of the file during read operation.</p>\r
+</div>\r
+\r
+\r
+<div class="para comp">\r
+<h4>QuickInfo</h4>\r
+<p>Always available.</p>\r
+</div>\r
+\r
+\r
+<div class="para ref">\r
+<h4>See Also</h4>\r
+<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
+</div>\r
+\r
+<p class="foot"><a href="../00index_e.html">Return</a></p>\r
+</body>\r
+</html>\r
projects / z180-stamp.git / blobdiff