mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2026-09-19 13:24:16 +00:00
Updated doxygen documentation.
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
<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="generator" content="Doxygen 1.15.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>libaaruformat: ImageInfo Struct Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -35,7 +35,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.14.0 -->
|
||||
<!-- Generated by Doxygen 1.15.0 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
</script>
|
||||
@@ -105,25 +105,25 @@ Data Fields</h2></td></tr>
|
||||
<tr class="memitem:aaeb20c53439a89baaf21944b3c97f676" id="r_aaeb20c53439a89baaf21944b3c97f676"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaeb20c53439a89baaf21944b3c97f676">HasSessions</a></td></tr>
|
||||
<tr class="memdesc:aaeb20c53439a89baaf21944b3c97f676"><td class="mdescLeft"> </td><td class="mdescRight">Image contains multiple sessions (optical media); 0=single/none, non-zero=multi. <br /></td></tr>
|
||||
<tr class="memitem:abca8e73a9655d810e6d30d36c3ab54d7" id="r_abca8e73a9655d810e6d30d36c3ab54d7"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#abca8e73a9655d810e6d30d36c3ab54d7">ImageSize</a></td></tr>
|
||||
<tr class="memdesc:abca8e73a9655d810e6d30d36c3ab54d7"><td class="mdescLeft"> </td><td class="mdescRight">Size of the image payload in bytes (excludes headers/metadata) <br /></td></tr>
|
||||
<tr class="memdesc:abca8e73a9655d810e6d30d36c3ab54d7"><td class="mdescLeft"> </td><td class="mdescRight">Size of the image payload in bytes (excludes headers/metadata). <br /></td></tr>
|
||||
<tr class="memitem:ae3e1b9cde1c51152b00eb1b59e199906" id="r_ae3e1b9cde1c51152b00eb1b59e199906"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3e1b9cde1c51152b00eb1b59e199906">Sectors</a></td></tr>
|
||||
<tr class="memdesc:ae3e1b9cde1c51152b00eb1b59e199906"><td class="mdescLeft"> </td><td class="mdescRight">Total count of addressable logical sectors/blocks. <br /></td></tr>
|
||||
<tr class="memitem:aac1ac48f57afd415467cd6f13f01644b" id="r_aac1ac48f57afd415467cd6f13f01644b"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#aac1ac48f57afd415467cd6f13f01644b">SectorSize</a></td></tr>
|
||||
<tr class="memdesc:aac1ac48f57afd415467cd6f13f01644b"><td class="mdescLeft"> </td><td class="mdescRight">Size of each logical sector in bytes (512, 2048, 2352, 4096, etc.) <br /></td></tr>
|
||||
<tr class="memdesc:aac1ac48f57afd415467cd6f13f01644b"><td class="mdescLeft"> </td><td class="mdescRight">Size of each logical sector in bytes (512, 2048, 2352, 4096, etc.). <br /></td></tr>
|
||||
<tr class="memitem:adce978941d9900c8c05e620df67f8c5c" id="r_adce978941d9900c8c05e620df67f8c5c"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#adce978941d9900c8c05e620df67f8c5c">Version</a> [32]</td></tr>
|
||||
<tr class="memdesc:adce978941d9900c8c05e620df67f8c5c"><td class="mdescLeft"> </td><td class="mdescRight">Image format version string (NUL-terminated, e.g., "6.0") <br /></td></tr>
|
||||
<tr class="memdesc:adce978941d9900c8c05e620df67f8c5c"><td class="mdescLeft"> </td><td class="mdescRight">Image format version string (NUL-terminated, e.g., "6.0"). <br /></td></tr>
|
||||
<tr class="memitem:aaea8b3a14fc03f9a4b045318160b7f54" id="r_aaea8b3a14fc03f9a4b045318160b7f54"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaea8b3a14fc03f9a4b045318160b7f54">Application</a> [64]</td></tr>
|
||||
<tr class="memdesc:aaea8b3a14fc03f9a4b045318160b7f54"><td class="mdescLeft"> </td><td class="mdescRight">Name of application that created the image (NUL-terminated) <br /></td></tr>
|
||||
<tr class="memdesc:aaea8b3a14fc03f9a4b045318160b7f54"><td class="mdescLeft"> </td><td class="mdescRight">Name of application that created the image (NUL-terminated). <br /></td></tr>
|
||||
<tr class="memitem:aebf7783c46e640a8e7d0192ba2843e9a" id="r_aebf7783c46e640a8e7d0192ba2843e9a"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#aebf7783c46e640a8e7d0192ba2843e9a">ApplicationVersion</a> [32]</td></tr>
|
||||
<tr class="memdesc:aebf7783c46e640a8e7d0192ba2843e9a"><td class="mdescLeft"> </td><td class="mdescRight">Version of the creating application (NUL-terminated) <br /></td></tr>
|
||||
<tr class="memdesc:aebf7783c46e640a8e7d0192ba2843e9a"><td class="mdescLeft"> </td><td class="mdescRight">Version of the creating application (NUL-terminated). <br /></td></tr>
|
||||
<tr class="memitem:acbccd97dbc139ed2f81d9997560725bb" id="r_acbccd97dbc139ed2f81d9997560725bb"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#acbccd97dbc139ed2f81d9997560725bb">CreationTime</a></td></tr>
|
||||
<tr class="memdesc:acbccd97dbc139ed2f81d9997560725bb"><td class="mdescLeft"> </td><td class="mdescRight">Image creation timestamp (Windows FILETIME: 100ns since 1601-01-01 UTC) <br /></td></tr>
|
||||
<tr class="memdesc:acbccd97dbc139ed2f81d9997560725bb"><td class="mdescLeft"> </td><td class="mdescRight">Image creation timestamp (Windows FILETIME: 100ns since 1601-01-01 UTC). <br /></td></tr>
|
||||
<tr class="memitem:ada8567fee9fbe636cb10f788b3705e3a" id="r_ada8567fee9fbe636cb10f788b3705e3a"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ada8567fee9fbe636cb10f788b3705e3a">LastModificationTime</a></td></tr>
|
||||
<tr class="memdesc:ada8567fee9fbe636cb10f788b3705e3a"><td class="mdescLeft"> </td><td class="mdescRight">Last modification timestamp (Windows FILETIME format) <br /></td></tr>
|
||||
<tr class="memdesc:ada8567fee9fbe636cb10f788b3705e3a"><td class="mdescLeft"> </td><td class="mdescRight">Last modification timestamp (Windows FILETIME format). <br /></td></tr>
|
||||
<tr class="memitem:a76611d5087e0a9fd4d329fac7c9ec3f3" id="r_a76611d5087e0a9fd4d329fac7c9ec3f3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a></td></tr>
|
||||
<tr class="memdesc:a76611d5087e0a9fd4d329fac7c9ec3f3"><td class="mdescLeft"> </td><td class="mdescRight">Media type identifier (see <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; 0=Unknown) <br /></td></tr>
|
||||
<tr class="memdesc:a76611d5087e0a9fd4d329fac7c9ec3f3"><td class="mdescLeft"> </td><td class="mdescRight">Media type identifier (see <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; 0=Unknown). <br /></td></tr>
|
||||
<tr class="memitem:a7ed25efcf8cec55d6609b83bcd17b2d0" id="r_a7ed25efcf8cec55d6609b83bcd17b2d0"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ed25efcf8cec55d6609b83bcd17b2d0">MetadataMediaType</a></td></tr>
|
||||
<tr class="memdesc:a7ed25efcf8cec55d6609b83bcd17b2d0"><td class="mdescLeft"> </td><td class="mdescRight">Media type for sidecar generation (internal archival use) <br /></td></tr>
|
||||
<tr class="memdesc:a7ed25efcf8cec55d6609b83bcd17b2d0"><td class="mdescLeft"> </td><td class="mdescRight">Media type for sidecar generation (internal archival use). <br /></td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>High-level summary of an opened Aaru image containing metadata and media characteristics. </p>
|
||||
@@ -223,7 +223,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Name of application that created the image (NUL-terminated) </p>
|
||||
<p>Name of application that created the image (NUL-terminated). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00929">929</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -243,7 +243,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Version of the creating application (NUL-terminated) </p>
|
||||
<p>Version of the creating application (NUL-terminated). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00930">930</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -263,7 +263,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Image creation timestamp (Windows FILETIME: 100ns since 1601-01-01 UTC) </p>
|
||||
<p>Image creation timestamp (Windows FILETIME: 100ns since 1601-01-01 UTC). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00931">931</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -323,7 +323,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Size of the image payload in bytes (excludes headers/metadata) </p>
|
||||
<p>Size of the image payload in bytes (excludes headers/metadata). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00925">925</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -343,7 +343,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Last modification timestamp (Windows FILETIME format) </p>
|
||||
<p>Last modification timestamp (Windows FILETIME format). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00932">932</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -363,7 +363,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Media type identifier (see <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; 0=Unknown) </p>
|
||||
<p>Media type identifier (see <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; 0=Unknown). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00933">933</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -383,7 +383,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Media type for sidecar generation (internal archival use) </p>
|
||||
<p>Media type for sidecar generation (internal archival use). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00934">934</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -423,7 +423,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Size of each logical sector in bytes (512, 2048, 2352, 4096, etc.) </p>
|
||||
<p>Size of each logical sector in bytes (512, 2048, 2352, 4096, etc.). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00927">927</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -443,7 +443,7 @@ Data Fields</h2></td></tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Image format version string (NUL-terminated, e.g., "6.0") </p>
|
||||
<p>Image format version string (NUL-terminated, e.g., "6.0"). </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00928">928</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
|
||||
|
||||
@@ -468,7 +468,7 @@ Data Fields</h2></td></tr>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a href="structImageInfo.html">ImageInfo</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>
|
||||
<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>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user