Repetier-Firmware-4-Davinci/api-doc/html/structdirectory_entry.html

344 wiersze
17 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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Repetier-Firmware: directoryEntry Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="repetier-logo-trans128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Repetier-Firmware
&#160;<span id="projectnumber">0.91</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('structdirectory_entry.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">directoryEntry Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="directoryEntry" -->
<p>FAT short directory entry.
<a href="structdirectory_entry.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_fat_structs_8h_source.html">FatStructs.h</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a03538c3434c511f082c32cda04754e0c">name</a> [11]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a983149395439fbc9ca8497076b75fd6b">attributes</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a937b2d2e4b78ddf9e42b19c754e4f31a">reservedNT</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a088ac767e59feb38599e0a53e6aacb82">creationTimeTenths</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a2b2b18a3fb988470278b1217abe946ab">creationTime</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#ab00be6268bf4c4f4b6014f056e27ba45">creationDate</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a5635857642ec25e070355257115dafd1">lastAccessDate</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#ad6224dfa27a1c558703f158e93ceafe0">firstClusterHigh</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#ab140bb773b2ff0ddf7199efc083ce037">lastWriteTime</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a26f462d6e4410d502149973ee6c216fd">lastWriteDate</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a3a4f70fb49494208d7eb349969a8acaa">firstClusterLow</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdirectory_entry.html#a48f46ad02b77a00b795d15626ba1d42e">fileSize</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>Field Documentation</h2>
<a class="anchor" id="a983149395439fbc9ca8497076b75fd6b"></a><!-- doxytag: member="directoryEntry::attributes" ref="a983149395439fbc9ca8497076b75fd6b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#a983149395439fbc9ca8497076b75fd6b">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="ab00be6268bf4c4f4b6014f056e27ba45"></a><!-- doxytag: member="directoryEntry::creationDate" ref="ab00be6268bf4c4f4b6014f056e27ba45" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#ab00be6268bf4c4f4b6014f056e27ba45">creationDate</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Date file was created. </p>
</div>
</div>
<a class="anchor" id="a2b2b18a3fb988470278b1217abe946ab"></a><!-- doxytag: member="directoryEntry::creationTime" ref="a2b2b18a3fb988470278b1217abe946ab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a2b2b18a3fb988470278b1217abe946ab">creationTime</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Time file was created. </p>
</div>
</div>
<a class="anchor" id="a088ac767e59feb38599e0a53e6aacb82"></a><!-- doxytag: member="directoryEntry::creationTimeTenths" ref="a088ac767e59feb38599e0a53e6aacb82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#a088ac767e59feb38599e0a53e6aacb82">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="a48f46ad02b77a00b795d15626ba1d42e"></a><!-- doxytag: member="directoryEntry::fileSize" ref="a48f46ad02b77a00b795d15626ba1d42e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structdirectory_entry.html#a48f46ad02b77a00b795d15626ba1d42e">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="ad6224dfa27a1c558703f158e93ceafe0"></a><!-- doxytag: member="directoryEntry::firstClusterHigh" ref="ad6224dfa27a1c558703f158e93ceafe0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#ad6224dfa27a1c558703f158e93ceafe0">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="a3a4f70fb49494208d7eb349969a8acaa"></a><!-- doxytag: member="directoryEntry::firstClusterLow" ref="a3a4f70fb49494208d7eb349969a8acaa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a3a4f70fb49494208d7eb349969a8acaa">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="a5635857642ec25e070355257115dafd1"></a><!-- doxytag: member="directoryEntry::lastAccessDate" ref="a5635857642ec25e070355257115dafd1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a5635857642ec25e070355257115dafd1">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="a26f462d6e4410d502149973ee6c216fd"></a><!-- doxytag: member="directoryEntry::lastWriteDate" ref="a26f462d6e4410d502149973ee6c216fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#a26f462d6e4410d502149973ee6c216fd">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="ab140bb773b2ff0ddf7199efc083ce037"></a><!-- doxytag: member="directoryEntry::lastWriteTime" ref="ab140bb773b2ff0ddf7199efc083ce037" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t <a class="el" href="structdirectory_entry.html#ab140bb773b2ff0ddf7199efc083ce037">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="a03538c3434c511f082c32cda04754e0c"></a><!-- doxytag: member="directoryEntry::name" ref="a03538c3434c511f082c32cda04754e0c" args="[11]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#a03538c3434c511f082c32cda04754e0c">name</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Short 8.3 name. 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="a937b2d2e4b78ddf9e42b19c754e4f31a"></a><!-- doxytag: member="directoryEntry::reservedNT" ref="a937b2d2e4b78ddf9e42b19c754e4f31a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t <a class="el" href="structdirectory_entry.html#a937b2d2e4b78ddf9e42b19c754e4f31a">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 files:<ul>
<li>src/ArduinoAVR/Repetier/<a class="el" href="_fat_structs_8h_source.html">FatStructs.h</a></li>
<li>src/ArduinoAVR/Repetier/<a class="el" href="_sd_fat_8h_source.html">SdFat.h</a></li>
</ul>
</div><!-- contents -->
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="structdirectory_entry.html">directoryEntry</a> </li>
<li class="footer">Generated on Mon Dec 30 2013 18:53:03 for Repetier-Firmware by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
</ul>
</div>
</body>
</html>