]> cloudbase.mooo.com Git - z180-stamp.git/blame_incremental - fatfs/documents/doc/fattime.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / documents / doc / fattime.html
... / ...
CommitLineData
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=utf-8">\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="alternate" hreflang="ja" title="Japanese" href="../ja/fattime.html">\r
8<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
9<title>FatFs - get_fattime</title>\r
10</head>\r
11\r
12<body>\r
13\r
14<div class="para func">\r
15<h2>get_fattime</h2>\r
16<p>The get_fattime function is called to get the current time.</p>\r
17<pre>\r
18DWORD get_fattime (void);\r
19</pre>\r
20</div>\r
21\r
22\r
23<div class="para ret">\r
24<h4>Return Value</h4>\r
25<p>Currnet local time shall be returned as bit-fields packed into a <tt>DWORD</tt> value. The bit fields are as follows:</p>\r
26<dl class="ret">\r
27<dt>bit31:25</dt>\r
28<dd>Year origin from the 1980 (0..127, e.g. 37 for 2017)</dd>\r
29<dt>bit24:21</dt>\r
30<dd>Month (1..12)</dd>\r
31<dt>bit20:16</dt>\r
32<dd>Day of the month (1..31)</dd>\r
33<dt>bit15:11</dt>\r
34<dd>Hour (0..23)</dd>\r
35<dt>bit10:5</dt>\r
36<dd>Minute (0..59)</dd>\r
37<dt>bit4:0</dt>\r
38<dd>Second / 2 (0..29, e.g. 25 for 50)</dd>\r
39</dl>\r
40</div>\r
41\r
42\r
43<div class="para desc">\r
44<h4>Description</h4>\r
45<p>The <tt>get_fattime</tt> function shall return any valid time even if the system does not support a real time clock. If a zero is returned, the file will not have a valid timestamp.</p>\r
46</div>\r
47\r
48\r
49<div class="para comp">\r
50<h4>QuickInfo</h4>\r
51<p>This function is not needed when <tt>FF_FS_READONLY == 1</tt> or <tt>FF_FS_NORTC == 1</tt>.</p>\r
52</div>\r
53\r
54\r
55<p class="foot"><a href="../00index_e.html">Return</a></p>\r
56</body>\r
57</html>\r