]> cloudbase.mooo.com Git - z180-stamp.git/blame - fatfs/documents/doc/eof.html
Import fatfs R0.13b
[z180-stamp.git] / fatfs / documents / doc / eof.html
CommitLineData
53668523
L
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
289f6a14 4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
53668523
L
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="alternate" hreflang="ja" title="Japanese" href="../ja/eof.html">\r
8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
9<title>FatFs - f_eof</title>\r
10</head>\r
11\r
12<body>\r
13\r
14<div class="para func">\r
15<h2>f_eof</h2>\r
16<p>The f_eof function tests for end-of-file on a file.</p>\r
17<pre>\r
18int f_eof (\r
19 FIL* <span class="arg">fp</span> <span class="c">/* [IN] File object */</span>\r
20);\r
21</pre>\r
22</div>\r
23\r
24\r
25<div class="para arg">\r
26<h4>Parameters</h4>\r
27<dl class="par">\r
28<dt>fp</dt>\r
29<dd>Pointer to the open file object structure.</dd>\r
30</dl>\r
31</div>\r
32\r
33\r
34<div class="para ret">\r
35<h4>Return Values</h4>\r
70702af1 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>\r
53668523
L
37</div>\r
38\r
39\r
40<div class="para desc">\r
41<h4>Description</h4>\r
70702af1 42<p>In this revision, this function is implemented as a macro. It does not have any validation and mutual exclusion.</p>\r
53668523 43<pre>\r
7b78a5a2 44<span class="k">#define</span> f_eof(fp) ((int)((fp)->fptr == (fp)->fsize))\r
53668523
L
45</pre>\r
46</div>\r
47\r
48\r
49<div class="para comp">\r
50<h4>QuickInfo</h4>\r
51<p>Always available.</p>\r
52</div>\r
53\r
54\r
55<div class="para ref">\r
56<h4>See Also</h4>\r
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>\r
58</div>\r
59\r
60<p class="foot"><a href="../00index_e.html">Return</a></p>\r
61</body>\r
62</html>\r