aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-04-24 06:59:28 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
d53faf7a38116a28af413effadd1aeaefee84bfd
libaaruformat/docs/html/structAaruHeader.html

344 lines
18 KiB
HTML
Raw Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<meta name="generator" content="Doxygen 1.15.0"/>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: AaruHeader Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<!-- Generated by Doxygen 1.15.0 -->
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('structAaruHeader.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">AaruHeader Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Version 1 container header placed at offset 0 for legacy / initial format.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="header_8h_source.html">aaruformat/structs/header.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ac127379f3983bae7bb74e0449b0ea8bd" id="r_ac127379f3983bae7bb74e0449b0ea8bd"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac127379f3983bae7bb74e0449b0ea8bd">identifier</a></td></tr>
<tr class="memdesc:ac127379f3983bae7bb74e0449b0ea8bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">File magic (AARU_MAGIC). <br /></td></tr>
<tr class="memitem:a6e3491e610ddb25885cba59ac9793193" id="r_a6e3491e610ddb25885cba59ac9793193"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e3491e610ddb25885cba59ac9793193">application</a> [64]</td></tr>
<tr class="memdesc:a6e3491e610ddb25885cba59ac9793193"><td class="mdescLeft">&#160;</td><td class="mdescRight">UTF-16LE creator application name (fixed-size buffer). <br /></td></tr>
<tr class="memitem:a95bd4c3c038bf354c04216e0a025aff3" id="r_a95bd4c3c038bf354c04216e0a025aff3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a95bd4c3c038bf354c04216e0a025aff3">imageMajorVersion</a></td></tr>
<tr class="memdesc:a95bd4c3c038bf354c04216e0a025aff3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container format major version (incompatible changes when incremented). <br /></td></tr>
<tr class="memitem:a9eb2bde1126e58254c82d4205a9f0ad5" id="r_a9eb2bde1126e58254c82d4205a9f0ad5"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9eb2bde1126e58254c82d4205a9f0ad5">imageMinorVersion</a></td></tr>
<tr class="memdesc:a9eb2bde1126e58254c82d4205a9f0ad5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container format minor version (backward compatible evolutions). <br /></td></tr>
<tr class="memitem:a50191fbb48b58fd10bbb4b4e6458fa0d" id="r_a50191fbb48b58fd10bbb4b4e6458fa0d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50191fbb48b58fd10bbb4b4e6458fa0d">applicationMajorVersion</a></td></tr>
<tr class="memdesc:a50191fbb48b58fd10bbb4b4e6458fa0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creator application major version. <br /></td></tr>
<tr class="memitem:a267034c125b34596ce7f580b56790c20" id="r_a267034c125b34596ce7f580b56790c20"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a267034c125b34596ce7f580b56790c20">applicationMinorVersion</a></td></tr>
<tr class="memdesc:a267034c125b34596ce7f580b56790c20"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creator application minor / patch version. <br /></td></tr>
<tr class="memitem:ac00dee40414001cdfc4b9fdcc4ebd6ef" id="r_ac00dee40414001cdfc4b9fdcc4ebd6ef"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac00dee40414001cdfc4b9fdcc4ebd6ef">mediaType</a></td></tr>
<tr class="memdesc:ac00dee40414001cdfc4b9fdcc4ebd6ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Media type enumeration (value from <a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a">MediaType</a>). <br /></td></tr>
<tr class="memitem:aacb36b5521218ce37b786a3db520b96e" id="r_aacb36b5521218ce37b786a3db520b96e"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aacb36b5521218ce37b786a3db520b96e">indexOffset</a></td></tr>
<tr class="memdesc:aacb36b5521218ce37b786a3db520b96e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Absolute byte offset to primary index block (MUST be &gt; 0; 0 =&gt; corrupt/unreadable). <br /></td></tr>
<tr class="memitem:afa18cc49ccc8e76f2aeb48b34af9f0be" id="r_afa18cc49ccc8e76f2aeb48b34af9f0be"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa18cc49ccc8e76f2aeb48b34af9f0be">creationTime</a></td></tr>
<tr class="memdesc:afa18cc49ccc8e76f2aeb48b34af9f0be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creation FILETIME (100 ns since 1601-01-01 UTC). <br /></td></tr>
<tr class="memitem:a0447bb5fd2938067455fc6b2f52b7dd4" id="r_a0447bb5fd2938067455fc6b2f52b7dd4"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0447bb5fd2938067455fc6b2f52b7dd4">lastWrittenTime</a></td></tr>
<tr class="memdesc:a0447bb5fd2938067455fc6b2f52b7dd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last modification FILETIME (100 ns since 1601-01-01 UTC). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Version 1 container header placed at offset 0 for legacy / initial format. </p>
<p>Field summary:</p><ul>
<li>identifier: magic signature (AARU_MAGIC) identifying the container.</li>
<li>application: UTF‑16LE creator application name (fixed 64 bytes, zero padded).</li>
<li>imageMajorVersion / imageMinorVersion: container format version of the file itself (not the app).</li>
<li>applicationMajorVersion / applicationMinorVersion: version of the creating application.</li>
<li>mediaType: media type enumeration (<a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a">MediaType</a>).</li>
<li>indexOffset: byte offset to the first index block (must be &gt; 0).</li>
<li>creationTime / lastWrittenTime: 64-bit Windows FILETIME timestamps (100 ns intervals since 1601-01-01 UTC). </li>
</ul>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00076">76</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a6e3491e610ddb25885cba59ac9793193" name="a6e3491e610ddb25885cba59ac9793193"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e3491e610ddb25885cba59ac9793193">&#9670;&#160;</a></span>application</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeader::application[64]</td>
</tr>
</table>
</div><div class="memdoc">
<p>UTF-16LE creator application name (fixed-size buffer). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00079">79</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="a50191fbb48b58fd10bbb4b4e6458fa0d" name="a50191fbb48b58fd10bbb4b4e6458fa0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50191fbb48b58fd10bbb4b4e6458fa0d">&#9670;&#160;</a></span>applicationMajorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeader::applicationMajorVersion</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creator application major version. </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00082">82</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="a267034c125b34596ce7f580b56790c20" name="a267034c125b34596ce7f580b56790c20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a267034c125b34596ce7f580b56790c20">&#9670;&#160;</a></span>applicationMinorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeader::applicationMinorVersion</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creator application minor / patch version. </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00083">83</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="afa18cc49ccc8e76f2aeb48b34af9f0be" name="afa18cc49ccc8e76f2aeb48b34af9f0be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa18cc49ccc8e76f2aeb48b34af9f0be">&#9670;&#160;</a></span>creationTime</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t AaruHeader::creationTime</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creation FILETIME (100 ns since 1601-01-01 UTC). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00086">86</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="ac127379f3983bae7bb74e0449b0ea8bd" name="ac127379f3983bae7bb74e0449b0ea8bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac127379f3983bae7bb74e0449b0ea8bd">&#9670;&#160;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t AaruHeader::identifier</td>
</tr>
</table>
</div><div class="memdoc">
<p>File magic (AARU_MAGIC). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00078">78</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="identify_8c_source.html#l00163">aaruf_identify_stream()</a>.</p>
</div>
</div>
<a id="a95bd4c3c038bf354c04216e0a025aff3" name="a95bd4c3c038bf354c04216e0a025aff3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95bd4c3c038bf354c04216e0a025aff3">&#9670;&#160;</a></span>imageMajorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeader::imageMajorVersion</td>
</tr>
</table>
</div><div class="memdoc">
<p>Container format major version (incompatible changes when incremented). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00080">80</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="identify_8c_source.html#l00163">aaruf_identify_stream()</a>.</p>
</div>
</div>
<a id="a9eb2bde1126e58254c82d4205a9f0ad5" name="a9eb2bde1126e58254c82d4205a9f0ad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9eb2bde1126e58254c82d4205a9f0ad5">&#9670;&#160;</a></span>imageMinorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeader::imageMinorVersion</td>
</tr>
</table>
</div><div class="memdoc">
<p>Container format minor version (backward compatible evolutions). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00081">81</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="aacb36b5521218ce37b786a3db520b96e" name="aacb36b5521218ce37b786a3db520b96e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacb36b5521218ce37b786a3db520b96e">&#9670;&#160;</a></span>indexOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t AaruHeader::indexOffset</td>
</tr>
</table>
</div><div class="memdoc">
<p>Absolute byte offset to primary index block (MUST be &gt; 0; 0 =&gt; corrupt/unreadable). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00085">85</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="a0447bb5fd2938067455fc6b2f52b7dd4" name="a0447bb5fd2938067455fc6b2f52b7dd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0447bb5fd2938067455fc6b2f52b7dd4">&#9670;&#160;</a></span>lastWrittenTime</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t AaruHeader::lastWrittenTime</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last modification FILETIME (100 ns since 1601-01-01 UTC). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00087">87</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="ac00dee40414001cdfc4b9fdcc4ebd6ef" name="ac00dee40414001cdfc4b9fdcc4ebd6ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac00dee40414001cdfc4b9fdcc4ebd6ef">&#9670;&#160;</a></span>mediaType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t AaruHeader::mediaType</td>
</tr>
</table>
</div><div class="memdoc">
<p>Media type enumeration (value from <a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a">MediaType</a>). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00084">84</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="header_8h_source.html">header.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structAaruHeader.html">AaruHeader</a></li>
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink