260 lines
13 KiB
HTML
260 lines
13 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<title>SdFat: directoryEntry Struct Reference</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
||
|
|
<div id="top">
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">SdFat</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-attribs">Public Attributes</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">directoryEntry Struct Reference</div> </div>
|
||
|
|
</div>
|
||
|
|
<div class="contents">
|
||
|
|
<!-- doxytag: class="directoryEntry" -->
|
||
|
|
<p>FAT short directory entry.
|
||
|
|
<a href="structdirectory_entry.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <SdFatStructs.h></code></p>
|
||
|
|
|
||
|
|
<p><a href="structdirectory_entry-members.html">List of all members.</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
|
||
|
|
Public Attributes</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a16c6cde55c8175c90935c386f1cfb21a">attributes</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a7b43372794655fe6604d3c17c02302fe">creationDate</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a622bfa70c2cd9006108d7473d737a953">creationTime</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#aa5e1ce5b411b88f005b28a3e7c7c5af6">creationTimeTenths</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#ac2445d99b50f925f662952e0ccd26a02">fileSize</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a3b492598b2b05e8425d2a500443613bd">firstClusterHigh</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a74bd660417a9c3501eae353326c14bb9">firstClusterLow</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#abca70dc5c5fcbe199fd78df010111331">lastAccessDate</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a12b2e7cf87482a942a0b5d3df6c51468">lastWriteDate</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a7bab435322d1928f66fbce53ee1f402d">lastWriteTime</a></td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a05dc993ea55a1a742de5970541a31ecb">name</a> [11]</td></tr>
|
||
|
|
<tr><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#afe7d00be85f3b78549b21610050da52b">reservedNT</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>FAT short directory entry. </p>
|
||
|
|
<p>Short means short 8.3 name, not the entry size.</p>
|
||
|
|
<p>Date Format. A FAT directory entry date stamp is a 16-bit field that is basically a date relative to the MS-DOS epoch of 01/01/1980. Here is the format (bit 0 is the LSB of the 16-bit word, bit 15 is the MSB of the 16-bit word):</p>
|
||
|
|
<p>Bits 9-15: Count of years from 1980, valid value range 0-127 inclusive (1980-2107).</p>
|
||
|
|
<p>Bits 5-8: Month of year, 1 = January, valid value range 1-12 inclusive.</p>
|
||
|
|
<p>Bits 0-4: Day of month, valid value range 1-31 inclusive.</p>
|
||
|
|
<p>Time Format. A FAT directory entry time stamp is a 16-bit field that has a granularity of 2 seconds. Here is the format (bit 0 is the LSB of the 16-bit word, bit 15 is the MSB of the 16-bit word).</p>
|
||
|
|
<p>Bits 11-15: Hours, valid value range 0-23 inclusive.</p>
|
||
|
|
<p>Bits 5-10: Minutes, valid value range 0-59 inclusive.</p>
|
||
|
|
<p>Bits 0-4: 2-second count, valid value range 0-29 inclusive (0 - 58 seconds).</p>
|
||
|
|
<p>The valid time range is from Midnight 00:00:00 to 23:59:58. </p>
|
||
|
|
</div><hr/><h2>Member Data Documentation</h2>
|
||
|
|
<a class="anchor" id="a16c6cde55c8175c90935c386f1cfb21a"></a><!-- doxytag: member="directoryEntry::attributes" ref="a16c6cde55c8175c90935c386f1cfb21a" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#a16c6cde55c8175c90935c386f1cfb21a">directoryEntry::attributes</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Entry attributes.</p>
|
||
|
|
<p>The upper two bits of the attribute byte are reserved and should always be set to 0 when a file is created and never modified or looked at after that. See defines that begin with DIR_ATT_. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a7b43372794655fe6604d3c17c02302fe"></a><!-- doxytag: member="directoryEntry::creationDate" ref="a7b43372794655fe6604d3c17c02302fe" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a7b43372794655fe6604d3c17c02302fe">directoryEntry::creationDate</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Date file was created. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a622bfa70c2cd9006108d7473d737a953"></a><!-- doxytag: member="directoryEntry::creationTime" ref="a622bfa70c2cd9006108d7473d737a953" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a622bfa70c2cd9006108d7473d737a953">directoryEntry::creationTime</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Time file was created. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa5e1ce5b411b88f005b28a3e7c7c5af6"></a><!-- doxytag: member="directoryEntry::creationTimeTenths" ref="aa5e1ce5b411b88f005b28a3e7c7c5af6" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#aa5e1ce5b411b88f005b28a3e7c7c5af6">directoryEntry::creationTimeTenths</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>The granularity of the seconds part of creationTime is 2 seconds so this field is a count of tenths of a second and its valid value range is 0-199 inclusive. (WHG note - seems to be hundredths) </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ac2445d99b50f925f662952e0ccd26a02"></a><!-- doxytag: member="directoryEntry::fileSize" ref="ac2445d99b50f925f662952e0ccd26a02" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint32_t <a class="el" href="structdirectory_entry.html#ac2445d99b50f925f662952e0ccd26a02">directoryEntry::fileSize</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>32-bit unsigned holding this file's size in bytes. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a3b492598b2b05e8425d2a500443613bd"></a><!-- doxytag: member="directoryEntry::firstClusterHigh" ref="a3b492598b2b05e8425d2a500443613bd" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a3b492598b2b05e8425d2a500443613bd">directoryEntry::firstClusterHigh</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>High word of this entry's first cluster number (always 0 for a FAT12 or FAT16 volume). </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a74bd660417a9c3501eae353326c14bb9"></a><!-- doxytag: member="directoryEntry::firstClusterLow" ref="a74bd660417a9c3501eae353326c14bb9" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a74bd660417a9c3501eae353326c14bb9">directoryEntry::firstClusterLow</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Low word of this entry's first cluster number. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="abca70dc5c5fcbe199fd78df010111331"></a><!-- doxytag: member="directoryEntry::lastAccessDate" ref="abca70dc5c5fcbe199fd78df010111331" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#abca70dc5c5fcbe199fd78df010111331">directoryEntry::lastAccessDate</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Last access date. Note that there is no last access time, only a date. This is the date of last read or write. In the case of a write, this should be set to the same date as lastWriteDate. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a12b2e7cf87482a942a0b5d3df6c51468"></a><!-- doxytag: member="directoryEntry::lastWriteDate" ref="a12b2e7cf87482a942a0b5d3df6c51468" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a12b2e7cf87482a942a0b5d3df6c51468">directoryEntry::lastWriteDate</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Date of last write. File creation is considered a write. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a7bab435322d1928f66fbce53ee1f402d"></a><!-- doxytag: member="directoryEntry::lastWriteTime" ref="a7bab435322d1928f66fbce53ee1f402d" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a7bab435322d1928f66fbce53ee1f402d">directoryEntry::lastWriteTime</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Time of last write. File creation is considered a write. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a05dc993ea55a1a742de5970541a31ecb"></a><!-- doxytag: member="directoryEntry::name" ref="a05dc993ea55a1a742de5970541a31ecb" args="[11]" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#a05dc993ea55a1a742de5970541a31ecb">directoryEntry::name</a>[11]</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Short 8.3 name.</p>
|
||
|
|
<p>The first eight bytes contain the file name with blank fill. The last three bytes contain the file extension with blank fill. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="afe7d00be85f3b78549b21610050da52b"></a><!-- doxytag: member="directoryEntry::reservedNT" ref="afe7d00be85f3b78549b21610050da52b" args="" -->
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#afe7d00be85f3b78549b21610050da52b">directoryEntry::reservedNT</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="memdoc">
|
||
|
|
<p>Reserved for use by Windows NT. Set value to 0 when a file is created and never modify or look at it after that. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
||
|
|
<li>Arduino/libraries/SdFat/<a class="el" href="_sd_fat_structs_8h.html">SdFatStructs.h</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<hr class="footer"/><address class="footer"><small>Generated on Thu Feb 7 2013 12:51:21 for SdFat by 
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|