aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f53092c9419c23941c845940125d0d3b580f415b
libaaruformat/docs/html/structAaruHeaderV2.html

506 lines
28 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"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: AaruHeaderV2 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 -->
<!-- Generated by Doxygen 1.14.0 -->
<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('structAaruHeaderV2.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">AaruHeaderV2 Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.
<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:a27af1bfabbc7650471a6010475116697" id="r_a27af1bfabbc7650471a6010475116697"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a27af1bfabbc7650471a6010475116697">identifier</a></td></tr>
<tr class="memdesc:a27af1bfabbc7650471a6010475116697"><td class="mdescLeft">&#160;</td><td class="mdescRight">File magic (AARU_MAGIC). <br /></td></tr>
<tr class="memitem:a0afcf9a5f565a9053351f44234c90dc3" id="r_a0afcf9a5f565a9053351f44234c90dc3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0afcf9a5f565a9053351f44234c90dc3">application</a> [64]</td></tr>
Updated documentation.
2025-10-13 14:26:33 +01:00
<tr class="memdesc:a0afcf9a5f565a9053351f44234c90dc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">UTF-8 creator application name (fixed 64 bytes). <br /></td></tr>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<tr class="memitem:af79ca31bcd428d1a54ac25c30d09b7a7" id="r_af79ca31bcd428d1a54ac25c30d09b7a7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af79ca31bcd428d1a54ac25c30d09b7a7">imageMajorVersion</a></td></tr>
<tr class="memdesc:af79ca31bcd428d1a54ac25c30d09b7a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container format major version. <br /></td></tr>
<tr class="memitem:ae2d6d3c7bc0a1956fb246cf7acbddeeb" id="r_ae2d6d3c7bc0a1956fb246cf7acbddeeb"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2d6d3c7bc0a1956fb246cf7acbddeeb">imageMinorVersion</a></td></tr>
<tr class="memdesc:ae2d6d3c7bc0a1956fb246cf7acbddeeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Container format minor version. <br /></td></tr>
<tr class="memitem:a1c26feafd945328f8f1854b523a0f03c" id="r_a1c26feafd945328f8f1854b523a0f03c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1c26feafd945328f8f1854b523a0f03c">applicationMajorVersion</a></td></tr>
<tr class="memdesc:a1c26feafd945328f8f1854b523a0f03c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creator application major version. <br /></td></tr>
<tr class="memitem:a5ae79accbb8ba2762d01a63ad334ee60" id="r_a5ae79accbb8ba2762d01a63ad334ee60"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ae79accbb8ba2762d01a63ad334ee60">applicationMinorVersion</a></td></tr>
<tr class="memdesc:a5ae79accbb8ba2762d01a63ad334ee60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creator application minor / patch version. <br /></td></tr>
<tr class="memitem:a81b114ab2b1fa786f64e9e914af3ba27" id="r_a81b114ab2b1fa786f64e9e914af3ba27"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a81b114ab2b1fa786f64e9e914af3ba27">mediaType</a></td></tr>
<tr class="memdesc:a81b114ab2b1fa786f64e9e914af3ba27"><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:a4ec4b1d593f5a0af19f6d7b8eaeada40" id="r_a4ec4b1d593f5a0af19f6d7b8eaeada40"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ec4b1d593f5a0af19f6d7b8eaeada40">indexOffset</a></td></tr>
<tr class="memdesc:a4ec4b1d593f5a0af19f6d7b8eaeada40"><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:ae849dae5af5cf31b1b815ef67b3c621f" id="r_ae849dae5af5cf31b1b815ef67b3c621f"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae849dae5af5cf31b1b815ef67b3c621f">creationTime</a></td></tr>
<tr class="memdesc:ae849dae5af5cf31b1b815ef67b3c621f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creation FILETIME (100 ns since 1601-01-01 UTC). <br /></td></tr>
<tr class="memitem:a45bc7e2afc9008ce6f4ae1dba93bdac3" id="r_a45bc7e2afc9008ce6f4ae1dba93bdac3"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a45bc7e2afc9008ce6f4ae1dba93bdac3">lastWrittenTime</a></td></tr>
<tr class="memdesc:a45bc7e2afc9008ce6f4ae1dba93bdac3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last modification FILETIME (100 ns since 1601-01-01 UTC). <br /></td></tr>
<tr class="memitem:a69ff1a1dbdaf0501e6488451b7270b51" id="r_a69ff1a1dbdaf0501e6488451b7270b51"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a69ff1a1dbdaf0501e6488451b7270b51">guid</a> [16]</td></tr>
<tr class="memdesc:a69ff1a1dbdaf0501e6488451b7270b51"><td class="mdescLeft">&#160;</td><td class="mdescRight">128-bit image GUID (binary, not text); stable across children. <br /></td></tr>
<tr class="memitem:ac55c9959435ff7b62a72ec8243ebe1c8" id="r_ac55c9959435ff7b62a72ec8243ebe1c8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac55c9959435ff7b62a72ec8243ebe1c8">blockAlignmentShift</a></td></tr>
<tr class="memdesc:ac55c9959435ff7b62a72ec8243ebe1c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">log2 block alignment (block size alignment = 2^blockAlignmentShift bytes). <br /></td></tr>
<tr class="memitem:a520d6f22b18a42fee0c6d72fbe3e064d" id="r_a520d6f22b18a42fee0c6d72fbe3e064d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a520d6f22b18a42fee0c6d72fbe3e064d">dataShift</a></td></tr>
<tr class="memdesc:a520d6f22b18a42fee0c6d72fbe3e064d"><td class="mdescLeft">&#160;</td><td class="mdescRight">log2 sectors/items per block-index increment in DDT entries (2^dataShift). <br /></td></tr>
<tr class="memitem:a35c4fa9c7e21cdea332efdb34383abad" id="r_a35c4fa9c7e21cdea332efdb34383abad"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a35c4fa9c7e21cdea332efdb34383abad">tableShift</a></td></tr>
<tr class="memdesc:a35c4fa9c7e21cdea332efdb34383abad"><td class="mdescLeft">&#160;</td><td class="mdescRight">log2 sectors spanned by each primary DDT entry (0 = single-level). <br /></td></tr>
<tr class="memitem:a4c3f5ccfe34123e402d1b7641d0d6c03" id="r_a4c3f5ccfe34123e402d1b7641d0d6c03"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4c3f5ccfe34123e402d1b7641d0d6c03">featureCompatible</a></td></tr>
<tr class="memdesc:a4c3f5ccfe34123e402d1b7641d0d6c03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Feature bits: unimplemented bits are ignorable (still R/W safe). <br /></td></tr>
<tr class="memitem:a9dae72bee3d161760dbbe389e4a70444" id="r_a9dae72bee3d161760dbbe389e4a70444"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9dae72bee3d161760dbbe389e4a70444">featureCompatibleRo</a></td></tr>
<tr class="memdesc:a9dae72bee3d161760dbbe389e4a70444"><td class="mdescLeft">&#160;</td><td class="mdescRight">Feature bits: unimplemented -&gt; degrade to read-only access. <br /></td></tr>
<tr class="memitem:a3a3a71ed3c7d48791a450b822c05ea2a" id="r_a3a3a71ed3c7d48791a450b822c05ea2a"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3a3a71ed3c7d48791a450b822c05ea2a">featureIncompatible</a></td></tr>
<tr class="memdesc:a3a3a71ed3c7d48791a450b822c05ea2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Feature bits: any unimplemented -&gt; abort (cannot open safely). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps. </p>
<p>Additions over v1:</p><ul>
<li>guid: stable 128-bit identifier enabling linkage by derivative images.</li>
<li>blockAlignmentShift / dataShift / tableShift: global structural hints copied into data &amp; DDT blocks.</li>
<li>featureCompatible / featureCompatibleRo / featureIncompatible: capability bitmasks.</li>
</ul>
<p>Feature bitmask semantics:</p><ul>
<li>featureCompatible: Optional features; absence of implementation should not impact R/W correctness.</li>
<li>featureCompatibleRo: If unimplemented, image MAY be opened read-only.</li>
<li>featureIncompatible: If any bit unimplemented, image MUST NOT be opened (prevent misinterpretation).</li>
</ul>
<p>Readers should AND their supported bit set with the header masks to decide access level (see file documentation). Writers must preserve unknown bits when saving an existing image. </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00106">106</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="a0afcf9a5f565a9053351f44234c90dc3" name="a0afcf9a5f565a9053351f44234c90dc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0afcf9a5f565a9053351f44234c90dc3">&#9670;&#160;</a></span>application</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::application[64]</td>
</tr>
</table>
</div><div class="memdoc">
Updated documentation.
2025-10-13 14:26:33 +01:00
<p>UTF-8 creator application name (fixed 64 bytes). </p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00109">109</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a1c26feafd945328f8f1854b523a0f03c" name="a1c26feafd945328f8f1854b523a0f03c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c26feafd945328f8f1854b523a0f03c">&#9670;&#160;</a></span>applicationMajorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::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#l00112">112</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a5ae79accbb8ba2762d01a63ad334ee60" name="a5ae79accbb8ba2762d01a63ad334ee60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae79accbb8ba2762d01a63ad334ee60">&#9670;&#160;</a></span>applicationMinorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::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#l00113">113</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="ac55c9959435ff7b62a72ec8243ebe1c8" name="ac55c9959435ff7b62a72ec8243ebe1c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac55c9959435ff7b62a72ec8243ebe1c8">&#9670;&#160;</a></span>blockAlignmentShift</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::blockAlignmentShift</td>
</tr>
</table>
</div><div class="memdoc">
<p>log2 block alignment (block size alignment = 2^blockAlignmentShift bytes). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00119">119</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="ae849dae5af5cf31b1b815ef67b3c621f" name="ae849dae5af5cf31b1b815ef67b3c621f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae849dae5af5cf31b1b815ef67b3c621f">&#9670;&#160;</a></span>creationTime</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t AaruHeaderV2::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#l00116">116</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a520d6f22b18a42fee0c6d72fbe3e064d" name="a520d6f22b18a42fee0c6d72fbe3e064d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a520d6f22b18a42fee0c6d72fbe3e064d">&#9670;&#160;</a></span>dataShift</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::dataShift</td>
</tr>
</table>
</div><div class="memdoc">
<p>log2 sectors/items per block-index increment in DDT entries (2^dataShift). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00120">120</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="a4c3f5ccfe34123e402d1b7641d0d6c03" name="a4c3f5ccfe34123e402d1b7641d0d6c03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c3f5ccfe34123e402d1b7641d0d6c03">&#9670;&#160;</a></span>featureCompatible</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t AaruHeaderV2::featureCompatible</td>
</tr>
</table>
</div><div class="memdoc">
<p>Feature bits: unimplemented bits are ignorable (still R/W safe). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00122">122</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="a9dae72bee3d161760dbbe389e4a70444" name="a9dae72bee3d161760dbbe389e4a70444"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dae72bee3d161760dbbe389e4a70444">&#9670;&#160;</a></span>featureCompatibleRo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t AaruHeaderV2::featureCompatibleRo</td>
</tr>
</table>
</div><div class="memdoc">
<p>Feature bits: unimplemented -&gt; degrade to read-only access. </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00123">123</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="a3a3a71ed3c7d48791a450b822c05ea2a" name="a3a3a71ed3c7d48791a450b822c05ea2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a3a71ed3c7d48791a450b822c05ea2a">&#9670;&#160;</a></span>featureIncompatible</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t AaruHeaderV2::featureIncompatible</td>
</tr>
</table>
</div><div class="memdoc">
<p>Feature bits: any unimplemented -&gt; abort (cannot open safely). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00124">124</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
</div>
</div>
<a id="a69ff1a1dbdaf0501e6488451b7270b51" name="a69ff1a1dbdaf0501e6488451b7270b51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69ff1a1dbdaf0501e6488451b7270b51">&#9670;&#160;</a></span>guid</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::guid[16]</td>
</tr>
</table>
</div><div class="memdoc">
<p>128-bit image GUID (binary, not text); stable across children. </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00118">118</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
Updated documentation.
2025-10-13 14:26:33 +01:00
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a27af1bfabbc7650471a6010475116697" name="a27af1bfabbc7650471a6010475116697"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27af1bfabbc7650471a6010475116697">&#9670;&#160;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t AaruHeaderV2::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#l00108">108</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="af79ca31bcd428d1a54ac25c30d09b7a7" name="af79ca31bcd428d1a54ac25c30d09b7a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af79ca31bcd428d1a54ac25c30d09b7a7">&#9670;&#160;</a></span>imageMajorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::imageMajorVersion</td>
</tr>
</table>
</div><div class="memdoc">
<p>Container format major version. </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00110">110</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>, <a class="el" href="index__v1_8c_source.html#l00225">verify_index_v1()</a>, <a class="el" href="index__v2_8c_source.html#l00227">verify_index_v2()</a>, and <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>.</p>
</div>
</div>
<a id="ae2d6d3c7bc0a1956fb246cf7acbddeeb" name="ae2d6d3c7bc0a1956fb246cf7acbddeeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2d6d3c7bc0a1956fb246cf7acbddeeb">&#9670;&#160;</a></span>imageMinorVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::imageMinorVersion</td>
</tr>
</table>
</div><div class="memdoc">
<p>Container format minor version. </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00111">111</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a4ec4b1d593f5a0af19f6d7b8eaeada40" name="a4ec4b1d593f5a0af19f6d7b8eaeada40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ec4b1d593f5a0af19f6d7b8eaeada40">&#9670;&#160;</a></span>indexOffset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t AaruHeaderV2::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#l00115">115</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="index__v1_8c_source.html#l00079">process_index_v1()</a>, <a class="el" href="index__v2_8c_source.html#l00081">process_index_v2()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="index__v1_8c_source.html#l00225">verify_index_v1()</a>, <a class="el" href="index__v2_8c_source.html#l00227">verify_index_v2()</a>, <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close_8c_source.html#l03862">write_index_block()</a>.</p>
</div>
</div>
<a id="a45bc7e2afc9008ce6f4ae1dba93bdac3" name="a45bc7e2afc9008ce6f4ae1dba93bdac3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45bc7e2afc9008ce6f4ae1dba93bdac3">&#9670;&#160;</a></span>lastWrittenTime</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t AaruHeaderV2::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#l00117">117</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a81b114ab2b1fa786f64e9e914af3ba27" name="a81b114ab2b1fa786f64e9e914af3ba27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81b114ab2b1fa786f64e9e914af3ba27">&#9670;&#160;</a></span>mediaType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t AaruHeaderV2::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#l00114">114</a> of file <a class="el" href="header_8h_source.html">header.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a35c4fa9c7e21cdea332efdb34383abad" name="a35c4fa9c7e21cdea332efdb34383abad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35c4fa9c7e21cdea332efdb34383abad">&#9670;&#160;</a></span>tableShift</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t AaruHeaderV2::tableShift</td>
</tr>
</table>
</div><div class="memdoc">
<p>log2 sectors spanned by each primary DDT entry (0 = single-level). </p>
<p class="definition">Definition at line <a class="el" href="header_8h_source.html#l00121">121</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="structAaruHeaderV2.html">AaruHeaderV2</a></li>
<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.14.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink