Files
libaaruformat/docs/html/structDumpHardwareEntry.html

336 lines
19 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: DumpHardwareEntry 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('structDumpHardwareEntry.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">DumpHardwareEntry Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Per-environment length table describing subsequent UTF-8 strings and optional extent array.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="dump_8h_source.html">aaruformat/structs/dump.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:a38a2c1b15dc4cabc02b4124b3a52c8db" id="r_a38a2c1b15dc4cabc02b4124b3a52c8db"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a38a2c1b15dc4cabc02b4124b3a52c8db">manufacturerLength</a></td></tr>
<tr class="memdesc:a38a2c1b15dc4cabc02b4124b3a52c8db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of manufacturer UTF-8 string. <br /></td></tr>
<tr class="memitem:a81f6da3ced18e060c27a3bc3ac4387c3" id="r_a81f6da3ced18e060c27a3bc3ac4387c3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a81f6da3ced18e060c27a3bc3ac4387c3">modelLength</a></td></tr>
<tr class="memdesc:a81f6da3ced18e060c27a3bc3ac4387c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of model UTF-8 string. <br /></td></tr>
<tr class="memitem:aca3e85fe2b6b8dd49afde691e5cf1ee8" id="r_aca3e85fe2b6b8dd49afde691e5cf1ee8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aca3e85fe2b6b8dd49afde691e5cf1ee8">revisionLength</a></td></tr>
<tr class="memdesc:aca3e85fe2b6b8dd49afde691e5cf1ee8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of revision / hardware revision string. <br /></td></tr>
<tr class="memitem:a52948ae4f0d07e4d861e79def4a0deec" id="r_a52948ae4f0d07e4d861e79def4a0deec"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a52948ae4f0d07e4d861e79def4a0deec">firmwareLength</a></td></tr>
<tr class="memdesc:a52948ae4f0d07e4d861e79def4a0deec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of firmware version string. <br /></td></tr>
<tr class="memitem:ab363d118785e94df2acc0c8dc1a9d1b5" id="r_ab363d118785e94df2acc0c8dc1a9d1b5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab363d118785e94df2acc0c8dc1a9d1b5">serialLength</a></td></tr>
<tr class="memdesc:ab363d118785e94df2acc0c8dc1a9d1b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of device serial number string. <br /></td></tr>
<tr class="memitem:a20025e2e89599dd60a83ca623fc9a200" id="r_a20025e2e89599dd60a83ca623fc9a200"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a20025e2e89599dd60a83ca623fc9a200">softwareNameLength</a></td></tr>
<tr class="memdesc:a20025e2e89599dd60a83ca623fc9a200"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of dumping software name string. <br /></td></tr>
<tr class="memitem:a4b4d1afcec5c3a0ec0e5f61fc481171d" id="r_a4b4d1afcec5c3a0ec0e5f61fc481171d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b4d1afcec5c3a0ec0e5f61fc481171d">softwareVersionLength</a></td></tr>
<tr class="memdesc:a4b4d1afcec5c3a0ec0e5f61fc481171d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of dumping software version string. <br /></td></tr>
<tr class="memitem:adea9ba6d578c27ee86524e7ff91dcbdd" id="r_adea9ba6d578c27ee86524e7ff91dcbdd"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adea9ba6d578c27ee86524e7ff91dcbdd">softwareOperatingSystemLength</a></td></tr>
<tr class="memdesc:adea9ba6d578c27ee86524e7ff91dcbdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length in bytes of host operating system string. <br /></td></tr>
<tr class="memitem:a558ff77451f13188e00f5b8da4c595ad" id="r_a558ff77451f13188e00f5b8da4c595ad"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a558ff77451f13188e00f5b8da4c595ad">extents</a></td></tr>
<tr class="memdesc:a558ff77451f13188e00f5b8da4c595ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="structDumpExtent.html" title="Inclusive [start,end] logical sector range contributed by a single hardware environment.">DumpExtent</a> records following the strings (0 = none). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Per-environment length table describing subsequent UTF-8 strings and optional extent array. </p>
<p>Immediately after this structure the variable-length UTF8 strings appear in the documented order, each present only if its corresponding length is non-zero. No padding is present between strings. When all strings are consumed, an array of <a class="el" href="structDumpExtent.html">DumpExtent</a> follows if <a class="el" href="#a558ff77451f13188e00f5b8da4c595ad">extents</a> &gt; 0.</p>
<p>All length fields measure bytes (not characters) and exclude any in-memory NUL terminator added by the reader.</p>
<p>Typical semantics:</p><ul>
<li>manufacturer/model/revision/firmware/serial identify the hardware device.</li>
<li>softwareName/softwareVersion/softwareOperatingSystem identify the acquisition software environment.</li>
<li>extents list which logical ranges this environment actually dumped (useful for multi-device composites). </li>
</ul>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00112">112</a> of file <a class="el" href="dump_8h_source.html">dump.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="a558ff77451f13188e00f5b8da4c595ad" name="a558ff77451f13188e00f5b8da4c595ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a558ff77451f13188e00f5b8da4c595ad">&#9670;&#160;</a></span>extents</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::extents</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <a class="el" href="structDumpExtent.html" title="Inclusive [start,end] logical sector range contributed by a single hardware environment.">DumpExtent</a> records following the strings (0 = none). </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00122">122</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="dump_8c_source.html#l00531">aaruf_set_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a52948ae4f0d07e4d861e79def4a0deec" name="a52948ae4f0d07e4d861e79def4a0deec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52948ae4f0d07e4d861e79def4a0deec">&#9670;&#160;</a></span>firmwareLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::firmwareLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of firmware version string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00117">117</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a38a2c1b15dc4cabc02b4124b3a52c8db" name="a38a2c1b15dc4cabc02b4124b3a52c8db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38a2c1b15dc4cabc02b4124b3a52c8db">&#9670;&#160;</a></span>manufacturerLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::manufacturerLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of manufacturer UTF-8 string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00114">114</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a81f6da3ced18e060c27a3bc3ac4387c3" name="a81f6da3ced18e060c27a3bc3ac4387c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81f6da3ced18e060c27a3bc3ac4387c3">&#9670;&#160;</a></span>modelLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::modelLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of model UTF-8 string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00115">115</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="aca3e85fe2b6b8dd49afde691e5cf1ee8" name="aca3e85fe2b6b8dd49afde691e5cf1ee8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca3e85fe2b6b8dd49afde691e5cf1ee8">&#9670;&#160;</a></span>revisionLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::revisionLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of revision / hardware revision string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00116">116</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="ab363d118785e94df2acc0c8dc1a9d1b5" name="ab363d118785e94df2acc0c8dc1a9d1b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab363d118785e94df2acc0c8dc1a9d1b5">&#9670;&#160;</a></span>serialLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::serialLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of device serial number string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00118">118</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a20025e2e89599dd60a83ca623fc9a200" name="a20025e2e89599dd60a83ca623fc9a200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20025e2e89599dd60a83ca623fc9a200">&#9670;&#160;</a></span>softwareNameLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::softwareNameLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of dumping software name string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00119">119</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="adea9ba6d578c27ee86524e7ff91dcbdd" name="adea9ba6d578c27ee86524e7ff91dcbdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adea9ba6d578c27ee86524e7ff91dcbdd">&#9670;&#160;</a></span>softwareOperatingSystemLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::softwareOperatingSystemLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of host operating system string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00121">121</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</a>.</p>
</div>
</div>
<a id="a4b4d1afcec5c3a0ec0e5f61fc481171d" name="a4b4d1afcec5c3a0ec0e5f61fc481171d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b4d1afcec5c3a0ec0e5f61fc481171d">&#9670;&#160;</a></span>softwareVersionLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t DumpHardwareEntry::softwareVersionLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length in bytes of dumping software version string. </p>
<p class="definition">Definition at line <a class="el" href="dump_8h_source.html#l00120">120</a> of file <a class="el" href="dump_8h_source.html">dump.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, and <a class="el" href="close_8c_source.html#l03447">write_dumphw_block()</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="dump_8h_source.html">dump.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="structDumpHardwareEntry.html">DumpHardwareEntry</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>