mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
Add doxygen documentation
This commit is contained in:
206
docs/html/header_8h_source.html
Normal file
206
docs/html/header_8h_source.html
Normal file
@@ -0,0 +1,206 @@
|
||||
<!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: include/aaruformat/structs/header.h Source File</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"> 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('header_8h_source.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">header.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="header_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * This file is part of the Aaru Data Preservation Suite.</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2019-2025 Natalia Portillo.</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * published by the Free Software Foundation; either version 2.1 of the</span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License, or (at your option) any later version.</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Lesser General Public License for more details.</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * License along with this library; if not, see <http://www.gnu.org/licenses/>.</span></div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef LIBAARUFORMAT_HEADER_H</span></div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_HEADER_H</span></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span></div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="header_8h.html#ab17964dacc36dca03ec5e75aa40a4502"> 59</a></span><span class="preprocessor">#define AARU_HEADER_APP_NAME_LEN 64 </span><span class="preprocessor"></span></div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="header_8h.html#a57c99b24137b82f12950e79ffbd2fb7a"> 60</a></span><span class="preprocessor">#define GUID_SIZE 16 </span><span class="preprocessor"></span></div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
|
||||
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="preprocessor">#pragma pack(push, 1)</span></div>
|
||||
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span></div>
|
||||
<div class="foldopen" id="foldopen00076" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structAaruHeader.html"> 76</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structAaruHeader.html">AaruHeader</a></div>
|
||||
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>{</div>
|
||||
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structAaruHeader.html#ac127379f3983bae7bb74e0449b0ea8bd"> 78</a></span> uint64_t <a class="code hl_variable" href="structAaruHeader.html#ac127379f3983bae7bb74e0449b0ea8bd">identifier</a>; </div>
|
||||
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="structAaruHeader.html#a6e3491e610ddb25885cba59ac9793193"> 79</a></span> uint8_t <a class="code hl_variable" href="structAaruHeader.html#a6e3491e610ddb25885cba59ac9793193">application</a>[<a class="code hl_define" href="header_8h.html#ab17964dacc36dca03ec5e75aa40a4502">AARU_HEADER_APP_NAME_LEN</a>]; </div>
|
||||
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="structAaruHeader.html#a95bd4c3c038bf354c04216e0a025aff3"> 80</a></span> uint8_t <a class="code hl_variable" href="structAaruHeader.html#a95bd4c3c038bf354c04216e0a025aff3">imageMajorVersion</a>; </div>
|
||||
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="structAaruHeader.html#a9eb2bde1126e58254c82d4205a9f0ad5"> 81</a></span> uint8_t <a class="code hl_variable" href="structAaruHeader.html#a9eb2bde1126e58254c82d4205a9f0ad5">imageMinorVersion</a>; </div>
|
||||
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="structAaruHeader.html#a50191fbb48b58fd10bbb4b4e6458fa0d"> 82</a></span> uint8_t <a class="code hl_variable" href="structAaruHeader.html#a50191fbb48b58fd10bbb4b4e6458fa0d">applicationMajorVersion</a>; </div>
|
||||
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="structAaruHeader.html#a267034c125b34596ce7f580b56790c20"> 83</a></span> uint8_t <a class="code hl_variable" href="structAaruHeader.html#a267034c125b34596ce7f580b56790c20">applicationMinorVersion</a>; </div>
|
||||
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="structAaruHeader.html#ac00dee40414001cdfc4b9fdcc4ebd6ef"> 84</a></span> uint32_t <a class="code hl_variable" href="structAaruHeader.html#ac00dee40414001cdfc4b9fdcc4ebd6ef">mediaType</a>; </div>
|
||||
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structAaruHeader.html#aacb36b5521218ce37b786a3db520b96e"> 85</a></span> uint64_t <a class="code hl_variable" href="structAaruHeader.html#aacb36b5521218ce37b786a3db520b96e">indexOffset</a>; </div>
|
||||
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="structAaruHeader.html#afa18cc49ccc8e76f2aeb48b34af9f0be"> 86</a></span> int64_t <a class="code hl_variable" href="structAaruHeader.html#afa18cc49ccc8e76f2aeb48b34af9f0be">creationTime</a>; </div>
|
||||
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structAaruHeader.html#a0447bb5fd2938067455fc6b2f52b7dd4"> 87</a></span> int64_t <a class="code hl_variable" href="structAaruHeader.html#a0447bb5fd2938067455fc6b2f52b7dd4">lastWrittenTime</a>; </div>
|
||||
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="header_8h.html#a92b4759381b275f18e8d66617bcefdfa"> 88</a></span>} <a class="code hl_struct" href="structAaruHeader.html">AaruHeader</a>;</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span></div>
|
||||
<div class="foldopen" id="foldopen00106" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html"> 106</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structAaruHeaderV2.html">AaruHeaderV2</a></div>
|
||||
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>{</div>
|
||||
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a27af1bfabbc7650471a6010475116697"> 108</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a27af1bfabbc7650471a6010475116697">identifier</a>; </div>
|
||||
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a0afcf9a5f565a9053351f44234c90dc3"> 109</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a0afcf9a5f565a9053351f44234c90dc3">application</a>[<a class="code hl_define" href="header_8h.html#ab17964dacc36dca03ec5e75aa40a4502">AARU_HEADER_APP_NAME_LEN</a>]; </div>
|
||||
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#af79ca31bcd428d1a54ac25c30d09b7a7"> 110</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#af79ca31bcd428d1a54ac25c30d09b7a7">imageMajorVersion</a>; </div>
|
||||
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#ae2d6d3c7bc0a1956fb246cf7acbddeeb"> 111</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#ae2d6d3c7bc0a1956fb246cf7acbddeeb">imageMinorVersion</a>; </div>
|
||||
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a1c26feafd945328f8f1854b523a0f03c"> 112</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a1c26feafd945328f8f1854b523a0f03c">applicationMajorVersion</a>; </div>
|
||||
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a5ae79accbb8ba2762d01a63ad334ee60"> 113</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a5ae79accbb8ba2762d01a63ad334ee60">applicationMinorVersion</a>; </div>
|
||||
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a81b114ab2b1fa786f64e9e914af3ba27"> 114</a></span> uint32_t <a class="code hl_variable" href="structAaruHeaderV2.html#a81b114ab2b1fa786f64e9e914af3ba27">mediaType</a>; </div>
|
||||
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a4ec4b1d593f5a0af19f6d7b8eaeada40"> 115</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a4ec4b1d593f5a0af19f6d7b8eaeada40">indexOffset</a>; </div>
|
||||
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#ae849dae5af5cf31b1b815ef67b3c621f"> 116</a></span> int64_t <a class="code hl_variable" href="structAaruHeaderV2.html#ae849dae5af5cf31b1b815ef67b3c621f">creationTime</a>; </div>
|
||||
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a45bc7e2afc9008ce6f4ae1dba93bdac3"> 117</a></span> int64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a45bc7e2afc9008ce6f4ae1dba93bdac3">lastWrittenTime</a>; </div>
|
||||
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a69ff1a1dbdaf0501e6488451b7270b51"> 118</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a69ff1a1dbdaf0501e6488451b7270b51">guid</a>[<a class="code hl_define" href="header_8h.html#a57c99b24137b82f12950e79ffbd2fb7a">GUID_SIZE</a>]; </div>
|
||||
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#ac55c9959435ff7b62a72ec8243ebe1c8"> 119</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#ac55c9959435ff7b62a72ec8243ebe1c8">blockAlignmentShift</a>; </div>
|
||||
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a520d6f22b18a42fee0c6d72fbe3e064d"> 120</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a520d6f22b18a42fee0c6d72fbe3e064d">dataShift</a>; </div>
|
||||
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a35c4fa9c7e21cdea332efdb34383abad"> 121</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a35c4fa9c7e21cdea332efdb34383abad">tableShift</a>; </div>
|
||||
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03"> 122</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03">featureCompatible</a>; </div>
|
||||
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444"> 123</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444">featureCompatibleRo</a>; </div>
|
||||
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a"> 124</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a">featureIncompatible</a>; </div>
|
||||
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="header_8h.html#a369effc2c0aea490cf0309c686ce54c6"> 125</a></span>} <a class="code hl_struct" href="structAaruHeaderV2.html">AaruHeaderV2</a>;</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
|
||||
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#pragma pack(pop)</span></div>
|
||||
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
|
||||
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_HEADER_H</span></div>
|
||||
<div class="ttc" id="aheader_8h_html_a57c99b24137b82f12950e79ffbd2fb7a"><div class="ttname"><a href="header_8h.html#a57c99b24137b82f12950e79ffbd2fb7a">GUID_SIZE</a></div><div class="ttdeci">#define GUID_SIZE</div><div class="ttdoc">Size in bytes of GUID / UUID-like binary identifier.</div><div class="ttdef"><b>Definition</b> <a href="#l00060">header.h:60</a></div></div>
|
||||
<div class="ttc" id="aheader_8h_html_ab17964dacc36dca03ec5e75aa40a4502"><div class="ttname"><a href="header_8h.html#ab17964dacc36dca03ec5e75aa40a4502">AARU_HEADER_APP_NAME_LEN</a></div><div class="ttdeci">#define AARU_HEADER_APP_NAME_LEN</div><div class="ttdoc">Size in bytes (UTF-16LE) of application name field (32 UTF-16 code units).</div><div class="ttdef"><b>Definition</b> <a href="#l00059">header.h:59</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html"><div class="ttname"><a href="structAaruHeaderV2.html">AaruHeaderV2</a></div><div class="ttdoc">Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.</div><div class="ttdef"><b>Definition</b> <a href="#l00106">header.h:107</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a0afcf9a5f565a9053351f44234c90dc3"><div class="ttname"><a href="structAaruHeaderV2.html#a0afcf9a5f565a9053351f44234c90dc3">AaruHeaderV2::application</a></div><div class="ttdeci">uint8_t application[64]</div><div class="ttdoc">UTF-16LE creator application name (fixed 64 bytes).</div><div class="ttdef"><b>Definition</b> <a href="#l00109">header.h:109</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a1c26feafd945328f8f1854b523a0f03c"><div class="ttname"><a href="structAaruHeaderV2.html#a1c26feafd945328f8f1854b523a0f03c">AaruHeaderV2::applicationMajorVersion</a></div><div class="ttdeci">uint8_t applicationMajorVersion</div><div class="ttdoc">Creator application major version.</div><div class="ttdef"><b>Definition</b> <a href="#l00112">header.h:112</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a27af1bfabbc7650471a6010475116697"><div class="ttname"><a href="structAaruHeaderV2.html#a27af1bfabbc7650471a6010475116697">AaruHeaderV2::identifier</a></div><div class="ttdeci">uint64_t identifier</div><div class="ttdoc">File magic (AARU_MAGIC).</div><div class="ttdef"><b>Definition</b> <a href="#l00108">header.h:108</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a35c4fa9c7e21cdea332efdb34383abad"><div class="ttname"><a href="structAaruHeaderV2.html#a35c4fa9c7e21cdea332efdb34383abad">AaruHeaderV2::tableShift</a></div><div class="ttdeci">uint8_t tableShift</div><div class="ttdoc">log2 sectors spanned by each primary DDT entry (0 = single-level).</div><div class="ttdef"><b>Definition</b> <a href="#l00121">header.h:121</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a3a3a71ed3c7d48791a450b822c05ea2a"><div class="ttname"><a href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a">AaruHeaderV2::featureIncompatible</a></div><div class="ttdeci">uint64_t featureIncompatible</div><div class="ttdoc">Feature bits: any unimplemented -> abort (cannot open safely).</div><div class="ttdef"><b>Definition</b> <a href="#l00124">header.h:124</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a45bc7e2afc9008ce6f4ae1dba93bdac3"><div class="ttname"><a href="structAaruHeaderV2.html#a45bc7e2afc9008ce6f4ae1dba93bdac3">AaruHeaderV2::lastWrittenTime</a></div><div class="ttdeci">int64_t lastWrittenTime</div><div class="ttdoc">Last modification FILETIME (100 ns since 1601-01-01 UTC).</div><div class="ttdef"><b>Definition</b> <a href="#l00117">header.h:117</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a4c3f5ccfe34123e402d1b7641d0d6c03"><div class="ttname"><a href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03">AaruHeaderV2::featureCompatible</a></div><div class="ttdeci">uint64_t featureCompatible</div><div class="ttdoc">Feature bits: unimplemented bits are ignorable (still R/W safe).</div><div class="ttdef"><b>Definition</b> <a href="#l00122">header.h:122</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a4ec4b1d593f5a0af19f6d7b8eaeada40"><div class="ttname"><a href="structAaruHeaderV2.html#a4ec4b1d593f5a0af19f6d7b8eaeada40">AaruHeaderV2::indexOffset</a></div><div class="ttdeci">uint64_t indexOffset</div><div class="ttdoc">Absolute byte offset to primary index block (MUST be > 0; 0 => corrupt/unreadable).</div><div class="ttdef"><b>Definition</b> <a href="#l00115">header.h:115</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a520d6f22b18a42fee0c6d72fbe3e064d"><div class="ttname"><a href="structAaruHeaderV2.html#a520d6f22b18a42fee0c6d72fbe3e064d">AaruHeaderV2::dataShift</a></div><div class="ttdeci">uint8_t dataShift</div><div class="ttdoc">log2 sectors/items per block-index increment in DDT entries (2^dataShift).</div><div class="ttdef"><b>Definition</b> <a href="#l00120">header.h:120</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a5ae79accbb8ba2762d01a63ad334ee60"><div class="ttname"><a href="structAaruHeaderV2.html#a5ae79accbb8ba2762d01a63ad334ee60">AaruHeaderV2::applicationMinorVersion</a></div><div class="ttdeci">uint8_t applicationMinorVersion</div><div class="ttdoc">Creator application minor / patch version.</div><div class="ttdef"><b>Definition</b> <a href="#l00113">header.h:113</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a69ff1a1dbdaf0501e6488451b7270b51"><div class="ttname"><a href="structAaruHeaderV2.html#a69ff1a1dbdaf0501e6488451b7270b51">AaruHeaderV2::guid</a></div><div class="ttdeci">uint8_t guid[16]</div><div class="ttdoc">128-bit image GUID (binary, not text); stable across children.</div><div class="ttdef"><b>Definition</b> <a href="#l00118">header.h:118</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a81b114ab2b1fa786f64e9e914af3ba27"><div class="ttname"><a href="structAaruHeaderV2.html#a81b114ab2b1fa786f64e9e914af3ba27">AaruHeaderV2::mediaType</a></div><div class="ttdeci">uint32_t mediaType</div><div class="ttdoc">Media type enumeration (value from MediaType).</div><div class="ttdef"><b>Definition</b> <a href="#l00114">header.h:114</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_a9dae72bee3d161760dbbe389e4a70444"><div class="ttname"><a href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444">AaruHeaderV2::featureCompatibleRo</a></div><div class="ttdeci">uint64_t featureCompatibleRo</div><div class="ttdoc">Feature bits: unimplemented -> degrade to read-only access.</div><div class="ttdef"><b>Definition</b> <a href="#l00123">header.h:123</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_ac55c9959435ff7b62a72ec8243ebe1c8"><div class="ttname"><a href="structAaruHeaderV2.html#ac55c9959435ff7b62a72ec8243ebe1c8">AaruHeaderV2::blockAlignmentShift</a></div><div class="ttdeci">uint8_t blockAlignmentShift</div><div class="ttdoc">log2 block alignment (block size alignment = 2^blockAlignmentShift bytes).</div><div class="ttdef"><b>Definition</b> <a href="#l00119">header.h:119</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_ae2d6d3c7bc0a1956fb246cf7acbddeeb"><div class="ttname"><a href="structAaruHeaderV2.html#ae2d6d3c7bc0a1956fb246cf7acbddeeb">AaruHeaderV2::imageMinorVersion</a></div><div class="ttdeci">uint8_t imageMinorVersion</div><div class="ttdoc">Container format minor version.</div><div class="ttdef"><b>Definition</b> <a href="#l00111">header.h:111</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_ae849dae5af5cf31b1b815ef67b3c621f"><div class="ttname"><a href="structAaruHeaderV2.html#ae849dae5af5cf31b1b815ef67b3c621f">AaruHeaderV2::creationTime</a></div><div class="ttdeci">int64_t creationTime</div><div class="ttdoc">Creation FILETIME (100 ns since 1601-01-01 UTC).</div><div class="ttdef"><b>Definition</b> <a href="#l00116">header.h:116</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeaderV2_html_af79ca31bcd428d1a54ac25c30d09b7a7"><div class="ttname"><a href="structAaruHeaderV2.html#af79ca31bcd428d1a54ac25c30d09b7a7">AaruHeaderV2::imageMajorVersion</a></div><div class="ttdeci">uint8_t imageMajorVersion</div><div class="ttdoc">Container format major version.</div><div class="ttdef"><b>Definition</b> <a href="#l00110">header.h:110</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html"><div class="ttname"><a href="structAaruHeader.html">AaruHeader</a></div><div class="ttdoc">Version 1 container header placed at offset 0 for legacy / initial format.</div><div class="ttdef"><b>Definition</b> <a href="#l00076">header.h:77</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_a0447bb5fd2938067455fc6b2f52b7dd4"><div class="ttname"><a href="structAaruHeader.html#a0447bb5fd2938067455fc6b2f52b7dd4">AaruHeader::lastWrittenTime</a></div><div class="ttdeci">int64_t lastWrittenTime</div><div class="ttdoc">Last modification FILETIME (100 ns since 1601-01-01 UTC).</div><div class="ttdef"><b>Definition</b> <a href="#l00087">header.h:87</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_a267034c125b34596ce7f580b56790c20"><div class="ttname"><a href="structAaruHeader.html#a267034c125b34596ce7f580b56790c20">AaruHeader::applicationMinorVersion</a></div><div class="ttdeci">uint8_t applicationMinorVersion</div><div class="ttdoc">Creator application minor / patch version.</div><div class="ttdef"><b>Definition</b> <a href="#l00083">header.h:83</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_a50191fbb48b58fd10bbb4b4e6458fa0d"><div class="ttname"><a href="structAaruHeader.html#a50191fbb48b58fd10bbb4b4e6458fa0d">AaruHeader::applicationMajorVersion</a></div><div class="ttdeci">uint8_t applicationMajorVersion</div><div class="ttdoc">Creator application major version.</div><div class="ttdef"><b>Definition</b> <a href="#l00082">header.h:82</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_a6e3491e610ddb25885cba59ac9793193"><div class="ttname"><a href="structAaruHeader.html#a6e3491e610ddb25885cba59ac9793193">AaruHeader::application</a></div><div class="ttdeci">uint8_t application[64]</div><div class="ttdoc">UTF-16LE creator application name (fixed-size buffer).</div><div class="ttdef"><b>Definition</b> <a href="#l00079">header.h:79</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_a95bd4c3c038bf354c04216e0a025aff3"><div class="ttname"><a href="structAaruHeader.html#a95bd4c3c038bf354c04216e0a025aff3">AaruHeader::imageMajorVersion</a></div><div class="ttdeci">uint8_t imageMajorVersion</div><div class="ttdoc">Container format major version (incompatible changes when incremented).</div><div class="ttdef"><b>Definition</b> <a href="#l00080">header.h:80</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_a9eb2bde1126e58254c82d4205a9f0ad5"><div class="ttname"><a href="structAaruHeader.html#a9eb2bde1126e58254c82d4205a9f0ad5">AaruHeader::imageMinorVersion</a></div><div class="ttdeci">uint8_t imageMinorVersion</div><div class="ttdoc">Container format minor version (backward compatible evolutions).</div><div class="ttdef"><b>Definition</b> <a href="#l00081">header.h:81</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_aacb36b5521218ce37b786a3db520b96e"><div class="ttname"><a href="structAaruHeader.html#aacb36b5521218ce37b786a3db520b96e">AaruHeader::indexOffset</a></div><div class="ttdeci">uint64_t indexOffset</div><div class="ttdoc">Absolute byte offset to primary index block (MUST be > 0; 0 => corrupt/unreadable).</div><div class="ttdef"><b>Definition</b> <a href="#l00085">header.h:85</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_ac00dee40414001cdfc4b9fdcc4ebd6ef"><div class="ttname"><a href="structAaruHeader.html#ac00dee40414001cdfc4b9fdcc4ebd6ef">AaruHeader::mediaType</a></div><div class="ttdeci">uint32_t mediaType</div><div class="ttdoc">Media type enumeration (value from MediaType).</div><div class="ttdef"><b>Definition</b> <a href="#l00084">header.h:84</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_ac127379f3983bae7bb74e0449b0ea8bd"><div class="ttname"><a href="structAaruHeader.html#ac127379f3983bae7bb74e0449b0ea8bd">AaruHeader::identifier</a></div><div class="ttdeci">uint64_t identifier</div><div class="ttdoc">File magic (AARU_MAGIC).</div><div class="ttdef"><b>Definition</b> <a href="#l00078">header.h:78</a></div></div>
|
||||
<div class="ttc" id="astructAaruHeader_html_afa18cc49ccc8e76f2aeb48b34af9f0be"><div class="ttname"><a href="structAaruHeader.html#afa18cc49ccc8e76f2aeb48b34af9f0be">AaruHeader::creationTime</a></div><div class="ttdeci">int64_t creationTime</div><div class="ttdoc">Creation FILETIME (100 ns since 1601-01-01 UTC).</div><div class="ttdef"><b>Definition</b> <a href="#l00086">header.h:86</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
</div><!-- container -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="header_8h.html">header.h</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
Block a user