• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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=utf-8">
5<meta http-equiv="Content-Style-Type" content="text/css">
6<link rel="up" title="FatFs" href="../00index_e.html">
7<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/eof.html">
8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
9<title>FatFs - f_eof</title>
10</head>
11
12<body>
13
14<div class="para func">
15<h2>f_eof</h2>
16<p>The f_eof function tests for end-of-file on a file.</p>
17<pre>
18int f_eof (
19  FIL* <span class="arg">fp</span>   <span class="c">/* [IN] File object */</span>
20);
21</pre>
22</div>
23
24
25<div class="para arg">
26<h4>Parameters</h4>
27<dl class="par">
28<dt>fp</dt>
29<dd>Pointer to the open file object structure.</dd>
30</dl>
31</div>
32
33
34<div class="para ret">
35<h4>Return Values</h4>
36<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>
37</div>
38
39
40<div class="para desc">
41<h4>Description</h4>
42<p>In this revision, this function is implemented as a macro. It does not have any validation and mutual exclusion.</p>
43<pre>
44<span class="k">#define</span> f_eof(fp) ((int)((fp)->fptr == (fp)->fsize))
45</pre>
46</div>
47
48
49<div class="para comp">
50<h4>QuickInfo</h4>
51<p>Always available.</p>
52</div>
53
54
55<div class="para ref">
56<h4>See Also</h4>
57<p><tt><a href="open.html">f_open</a>, <a href="lseek.html">f_lseek</a>, <a href="sfile.html">FIL</a></tt></p>
58</div>
59
60<p class="foot"><a href="../00index_e.html">Return</a></p>
61</body>
62</html>
63