Files
libaaruformat/docs/html/structIndexHeader2.html

198 lines
9.2 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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: IndexHeader2 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('structIndexHeader2.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">IndexHeader2 Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Index header (version 2) with 64bit entry counter (identifier == IndexBlock2).
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="index_8h_source.html">aaruformat/structs/index.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:a6b95ee733661cf13e56a46ecd1e048b0" id="r_a6b95ee733661cf13e56a46ecd1e048b0"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b95ee733661cf13e56a46ecd1e048b0">identifier</a></td></tr>
<tr class="memdesc:a6b95ee733661cf13e56a46ecd1e048b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier (must be BlockType::IndexBlock2). <br /></td></tr>
<tr class="memitem:a514ed0ba071841bc96f9583b67c664f9" id="r_a514ed0ba071841bc96f9583b67c664f9"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a514ed0ba071841bc96f9583b67c664f9">entries</a></td></tr>
<tr class="memdesc:a514ed0ba071841bc96f9583b67c664f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="structIndexEntry.html">IndexEntry</a> records that follow immediately. <br /></td></tr>
<tr class="memitem:a8851ba5d67ff638378d9e61db5413b8f" id="r_a8851ba5d67ff638378d9e61db5413b8f"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8851ba5d67ff638378d9e61db5413b8f">crc64</a></td></tr>
<tr class="memdesc:a8851ba5d67ff638378d9e61db5413b8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the entries array (legacy byte-swapped rule still applies for old versions). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Index header (version 2) with 64bit entry counter (identifier == IndexBlock2). </p>
<p>Enlarges the entry count field to 64 bits for large images; otherwise structurally identical to v1. </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00078">78</a> of file <a class="el" href="index_8h_source.html">index.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="a8851ba5d67ff638378d9e61db5413b8f" name="a8851ba5d67ff638378d9e61db5413b8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8851ba5d67ff638378d9e61db5413b8f">&#9670;&#160;</a></span>crc64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t IndexHeader2::crc64</td>
</tr>
</table>
</div><div class="memdoc">
<p>CRC64-ECMA of the entries array (legacy byte-swapped rule still applies for old versions). </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00082">82</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v2_8c_source.html#l00227">verify_index_v2()</a>.</p>
</div>
</div>
<a id="a514ed0ba071841bc96f9583b67c664f9" name="a514ed0ba071841bc96f9583b67c664f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a514ed0ba071841bc96f9583b67c664f9">&#9670;&#160;</a></span>entries</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t IndexHeader2::entries</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <a class="el" href="structIndexEntry.html">IndexEntry</a> records that follow immediately. </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00081">81</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v2_8c_source.html#l00081">process_index_v2()</a>, and <a class="el" href="index__v2_8c_source.html#l00227">verify_index_v2()</a>.</p>
</div>
</div>
<a id="a6b95ee733661cf13e56a46ecd1e048b0" name="a6b95ee733661cf13e56a46ecd1e048b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b95ee733661cf13e56a46ecd1e048b0">&#9670;&#160;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t IndexHeader2::identifier</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block identifier (must be BlockType::IndexBlock2). </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00080">80</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="index__v2_8c_source.html#l00081">process_index_v2()</a>, and <a class="el" href="index__v2_8c_source.html#l00227">verify_index_v2()</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="index_8h_source.html">index.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="structIndexHeader2.html">IndexHeader2</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>