]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/documents/doc/eof.html
Import fatfs R0.13b
[z180-stamp.git] / fatfs / documents / doc / eof.html
diff --git a/fatfs/documents/doc/eof.html b/fatfs/documents/doc/eof.html
new file mode 100644 (file)
index 0000000..efacfbf
--- /dev/null
@@ -0,0 +1,62 @@
+<!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=utf-8">\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/eof.html">\r
+<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
+<title>FatFs - f_eof</title>\r
+</head>\r
+\r
+<body>\r
+\r
+<div class="para func">\r
+<h2>f_eof</h2>\r
+<p>The f_eof function tests for end-of-file on a file.</p>\r
+<pre>\r
+int f_eof (\r
+  FIL* <span class="arg">fp</span>   <span class="c">/* [IN] File object */</span>\r
+);\r
+</pre>\r
+</div>\r
+\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 structure.</dd>\r
+</dl>\r
+</div>\r
+\r
+\r
+<div class="para ret">\r
+<h4>Return Values</h4>\r
+<p>The <tt>f_eof</tt> function returns a non-zero value if the read/write pointer has reached end of the file; otherwise it returns a zero.</p>\r
+</div>\r
+\r
+\r
+<div class="para desc">\r
+<h4>Description</h4>\r
+<p>In this revision, this function is implemented as a macro. It does not have any validation and mutual exclusion.</p>\r
+<pre>\r
+<span class="k">#define</span> f_eof(fp) ((int)((fp)->fptr == (fp)->fsize))\r
+</pre>\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="lseek.html">f_lseek</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