Update doxygen documentation.

This commit is contained in:
2025-12-31 10:59:13 +00:00
parent 48259087f8
commit e962e3443e
467 changed files with 14662 additions and 13929 deletions

View File

@@ -1777,7 +1777,7 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
</div>
<div class="line"><a id="l03327" name="l03327"></a><span class="lineno"> 3327</span></div>
<div class="foldopen" id="foldopen03423" data-start="{" data-end="}">
<div class="line"><a id="l03423" name="l03423"></a><span class="lineno"><a class="line" href="decls_8h.html#a8e00d26a8e751fbd412868ac4f92a3c0"> 3423</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="metadata_8c.html#a8e00d26a8e751fbd412868ac4f92a3c0">aaruf_get_negative_sectors</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint16_t *sectors)</div>
<div class="line"><a id="l03423" name="l03423"></a><span class="lineno"><a class="line" href="decls_8h.html#a381655339050570d969d2ddb60c9407b"> 3423</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="metadata_8c.html#a381655339050570d969d2ddb60c9407b">aaruf_get_negative_sectors</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint32_t *sectors)</div>
<div class="line"><a id="l03424" name="l03424"></a><span class="lineno"> 3424</span>{</div>
<div class="line"><a id="l03425" name="l03425"></a><span class="lineno"> 3425</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_get_negative_sectors(%p, %p)&quot;</span>, context, sectors);</div>
<div class="line"><a id="l03426" name="l03426"></a><span class="lineno"> 3426</span> </div>
@@ -1809,7 +1809,7 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
</div>
<div class="line"><a id="l03452" name="l03452"></a><span class="lineno"> 3452</span></div>
<div class="foldopen" id="foldopen03558" data-start="{" data-end="}">
<div class="line"><a id="l03558" name="l03558"></a><span class="lineno"><a class="line" href="decls_8h.html#aeeae64b120a10bac5e3d757a07a9691a"> 3558</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="metadata_8c.html#aeeae64b120a10bac5e3d757a07a9691a">aaruf_get_overflow_sectors</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint16_t *sectors)</div>
<div class="line"><a id="l03558" name="l03558"></a><span class="lineno"><a class="line" href="decls_8h.html#a108f816aba81cbb0f1401c2a9588660a"> 3558</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="metadata_8c.html#a108f816aba81cbb0f1401c2a9588660a">aaruf_get_overflow_sectors</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint32_t *sectors)</div>
<div class="line"><a id="l03559" name="l03559"></a><span class="lineno"> 3559</span>{</div>
<div class="line"><a id="l03560" name="l03560"></a><span class="lineno"> 3560</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">&quot;Entering aaruf_get_overflow_sectors(%p, %p)&quot;</span>, context, sectors);</div>
<div class="line"><a id="l03561" name="l03561"></a><span class="lineno"> 3561</span> </div>
@@ -2671,11 +2671,11 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
<div class="ttc" id="aconsts_8h_html_a3c3ba66fe2b547655c9e4b16a1ba519a"><div class="ttname"><a href="consts_8h.html#a3c3ba66fe2b547655c9e4b16a1ba519a">AARU_MAGIC</a></div><div class="ttdeci">#define AARU_MAGIC</div><div class="ttdoc">Magic identifier for AaruFormat container (ASCII &quot;AARUFRMT&quot;).</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00064">consts.h:64</a></div></div>
<div class="ttc" id="adecls_8h_html_a018e0da1c1f7e4f6187a982c0e40e056"><div class="ttname"><a href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a></div><div class="ttdeci">#define AARU_CALL</div><div class="ttdef"><b>Definition</b> <a href="decls_8h_source.html#l00045">decls.h:45</a></div></div>
<div class="ttc" id="adecls_8h_html_a9001412c35f3c92d3a9320d27b0d97f9"><div class="ttname"><a href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a></div><div class="ttdeci">#define AARU_EXPORT</div><div class="ttdef"><b>Definition</b> <a href="decls_8h_source.html#l00054">decls.h:54</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a76691ea3f772bf28e7446d171e205db2"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a76691ea3f772bf28e7446d171e205db2">GeometryBlock</a></div><div class="ttdeci">@ GeometryBlock</div><div class="ttdoc">Block containing logical geometry.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00149">enums.h:149</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a8ac77889f0c345ed861ed653a3063032"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a8ac77889f0c345ed861ed653a3063032">AaruMetadataJsonBlock</a></div><div class="ttdeci">@ AaruMetadataJsonBlock</div><div class="ttdoc">Block containing JSON version of Aaru Metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00160">enums.h:160</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3aa90947995922dcd8b27c998978aba359"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3aa90947995922dcd8b27c998978aba359">CicmBlock</a></div><div class="ttdeci">@ CicmBlock</div><div class="ttdoc">Block containing CICM XML metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00152">enums.h:152</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3ad5a8c9e1ce6a2acd795dc1e7561addf8"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3ad5a8c9e1ce6a2acd795dc1e7561addf8">MetadataBlock</a></div><div class="ttdeci">@ MetadataBlock</div><div class="ttdoc">Block containing metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00150">enums.h:150</a></div></div>
<div class="ttc" id="aerrors_8h_html_a1d6e49f7e8a1fa489efa0a582e90b5de"><div class="ttname"><a href="errors_8h.html#a1d6e49f7e8a1fa489efa0a582e90b5de">AARUF_STATUS_OK</a></div><div class="ttdeci">#define AARUF_STATUS_OK</div><div class="ttdoc">Sector present and read without uncorrectable errors.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00075">errors.h:75</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a76691ea3f772bf28e7446d171e205db2"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a76691ea3f772bf28e7446d171e205db2">GeometryBlock</a></div><div class="ttdeci">@ GeometryBlock</div><div class="ttdoc">Block containing logical geometry.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00150">enums.h:150</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a8ac77889f0c345ed861ed653a3063032"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a8ac77889f0c345ed861ed653a3063032">AaruMetadataJsonBlock</a></div><div class="ttdeci">@ AaruMetadataJsonBlock</div><div class="ttdoc">Block containing JSON version of Aaru Metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00161">enums.h:161</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3aa90947995922dcd8b27c998978aba359"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3aa90947995922dcd8b27c998978aba359">CicmBlock</a></div><div class="ttdeci">@ CicmBlock</div><div class="ttdoc">Block containing CICM XML metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00153">enums.h:153</a></div></div>
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3ad5a8c9e1ce6a2acd795dc1e7561addf8"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3ad5a8c9e1ce6a2acd795dc1e7561addf8">MetadataBlock</a></div><div class="ttdeci">@ MetadataBlock</div><div class="ttdoc">Block containing metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00151">enums.h:151</a></div></div>
<div class="ttc" id="aerrors_8h_html_a1d6e49f7e8a1fa489efa0a582e90b5de"><div class="ttname"><a href="errors_8h.html#a1d6e49f7e8a1fa489efa0a582e90b5de">AARUF_STATUS_OK</a></div><div class="ttdeci">#define AARUF_STATUS_OK</div><div class="ttdoc">Sector present and read without uncorrectable errors.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00076">errors.h:76</a></div></div>
<div class="ttc" id="aerrors_8h_html_a1df49eaa19eaa14891b6aaab966a9bc6"><div class="ttname"><a href="errors_8h.html#a1df49eaa19eaa14891b6aaab966a9bc6">AARUF_READ_ONLY</a></div><div class="ttdeci">#define AARUF_READ_ONLY</div><div class="ttdoc">Operation requires write mode but context is read-only.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00061">errors.h:61</a></div></div>
<div class="ttc" id="aerrors_8h_html_a35a771e3648bf971a004d4b2be9b5ec4"><div class="ttname"><a href="errors_8h.html#a35a771e3648bf971a004d4b2be9b5ec4">AARUF_ERROR_NOT_ENOUGH_MEMORY</a></div><div class="ttdeci">#define AARUF_ERROR_NOT_ENOUGH_MEMORY</div><div class="ttdoc">Memory allocation failure (critical).</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00048">errors.h:48</a></div></div>
<div class="ttc" id="aerrors_8h_html_a67753dacbd0ffdd397e563a8a5ecd271"><div class="ttname"><a href="errors_8h.html#a67753dacbd0ffdd397e563a8a5ecd271">AARUF_ERROR_CANNOT_READ_BLOCK</a></div><div class="ttdeci">#define AARUF_ERROR_CANNOT_READ_BLOCK</div><div class="ttdoc">Generic block read failure (seek/read error).</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00046">errors.h:46</a></div></div>
@@ -2691,6 +2691,7 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
<div class="ttc" id="ametadata_8c_html_a0d7349a92ffce2fa5515fae960c17b03"><div class="ttname"><a href="metadata_8c.html#a0d7349a92ffce2fa5515fae960c17b03">aaruf_clear_drive_firmware_revision</a></div><div class="ttdeci">int32_t aaruf_clear_drive_firmware_revision(void *context)</div><div class="ttdoc">Clears the drive firmware revision from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l04864">metadata.c:4864</a></div></div>
<div class="ttc" id="ametadata_8c_html_a0e5be9ff6d87218a8f5b451a27e1b39b"><div class="ttname"><a href="metadata_8c.html#a0e5be9ff6d87218a8f5b451a27e1b39b">aaruf_set_media_barcode</a></div><div class="ttdeci">int32_t aaruf_set_media_barcode(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the media barcode information for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l01180">metadata.c:1180</a></div></div>
<div class="ttc" id="ametadata_8c_html_a0ed36b14e49f1e924906d9c4b26d6214"><div class="ttname"><a href="metadata_8c.html#a0ed36b14e49f1e924906d9c4b26d6214">aaruf_set_media_model</a></div><div class="ttdeci">int32_t aaruf_set_media_model(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the media model or product designation for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l00943">metadata.c:943</a></div></div>
<div class="ttc" id="ametadata_8c_html_a108f816aba81cbb0f1401c2a9588660a"><div class="ttname"><a href="metadata_8c.html#a108f816aba81cbb0f1401c2a9588660a">aaruf_get_overflow_sectors</a></div><div class="ttdeci">int32_t aaruf_get_overflow_sectors(const void *context, uint32_t *sectors)</div><div class="ttdoc">Retrieves the number of overflow (post-gap) sectors in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="#l03558">metadata.c:3558</a></div></div>
<div class="ttc" id="ametadata_8c_html_a10d528163caf65134a7cec4a0c0a33b8"><div class="ttname"><a href="metadata_8c.html#a10d528163caf65134a7cec4a0c0a33b8">aaruf_set_media_sequence</a></div><div class="ttdeci">int32_t aaruf_set_media_sequence(void *context, const int32_t sequence, const int32_t last_sequence)</div><div class="ttdoc">Sets the media sequence information for multi-volume media sets.</div><div class="ttdef"><b>Definition</b> <a href="#l00365">metadata.c:365</a></div></div>
<div class="ttc" id="ametadata_8c_html_a1892cc8395305d7e85d04544ded62131"><div class="ttname"><a href="metadata_8c.html#a1892cc8395305d7e85d04544ded62131">aaruf_get_drive_serial_number</a></div><div class="ttdeci">int32_t aaruf_get_drive_serial_number(const void *context, uint8_t *buffer, int32_t *length)</div><div class="ttdoc">Retrieves the imaging drive&#39;s serial number metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l03114">metadata.c:3114</a></div></div>
<div class="ttc" id="ametadata_8c_html_a21d65b63e9806deb6dd0eb9c0e69eaf0"><div class="ttname"><a href="metadata_8c.html#a21d65b63e9806deb6dd0eb9c0e69eaf0">aaruf_clear_media_serial_number</a></div><div class="ttdeci">int32_t aaruf_clear_media_serial_number(void *context)</div><div class="ttdoc">Clears the media serial number from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l04343">metadata.c:4343</a></div></div>
@@ -2698,6 +2699,7 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
<div class="ttc" id="ametadata_8c_html_a29b6c38ce4b3420368ecb84007d8738d"><div class="ttname"><a href="metadata_8c.html#a29b6c38ce4b3420368ecb84007d8738d">aaruf_set_drive_model</a></div><div class="ttdeci">int32_t aaruf_set_drive_model(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the drive model information for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l01538">metadata.c:1538</a></div></div>
<div class="ttc" id="ametadata_8c_html_a2b5ef51f1913c62139b90cae0f97a9a2"><div class="ttname"><a href="metadata_8c.html#a2b5ef51f1913c62139b90cae0f97a9a2">aaruf_clear_media_barcode</a></div><div class="ttdeci">int32_t aaruf_clear_media_barcode(void *context)</div><div class="ttdoc">Clears the media barcode information from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l04429">metadata.c:4429</a></div></div>
<div class="ttc" id="ametadata_8c_html_a2f344544e412db0bfb46d3dfb509dd91"><div class="ttname"><a href="metadata_8c.html#a2f344544e412db0bfb46d3dfb509dd91">aaruf_set_media_title</a></div><div class="ttdeci">int32_t aaruf_set_media_title(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the media title or label for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l00723">metadata.c:723</a></div></div>
<div class="ttc" id="ametadata_8c_html_a381655339050570d969d2ddb60c9407b"><div class="ttname"><a href="metadata_8c.html#a381655339050570d969d2ddb60c9407b">aaruf_get_negative_sectors</a></div><div class="ttdeci">int32_t aaruf_get_negative_sectors(const void *context, uint32_t *sectors)</div><div class="ttdoc">Retrieves the number of negative (pre-gap) sectors in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="#l03423">metadata.c:3423</a></div></div>
<div class="ttc" id="ametadata_8c_html_a38d72be7e7854d6cb0bba89172e27b03"><div class="ttname"><a href="metadata_8c.html#a38d72be7e7854d6cb0bba89172e27b03">aaruf_get_creator</a></div><div class="ttdeci">int32_t aaruf_get_creator(const void *context, uint8_t *buffer, int32_t *length)</div><div class="ttdoc">Retrieves the recorded creator (operator) name from the MetadataBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l02410">metadata.c:2410</a></div></div>
<div class="ttc" id="ametadata_8c_html_a3db92f6bebf60195d6ab327e17988cee"><div class="ttname"><a href="metadata_8c.html#a3db92f6bebf60195d6ab327e17988cee">aaruf_get_drive_firmware_revision</a></div><div class="ttdeci">int32_t aaruf_get_drive_firmware_revision(const void *context, uint8_t *buffer, int32_t *length)</div><div class="ttdoc">Retrieves the firmware revision metadata for the imaging drive.</div><div class="ttdef"><b>Definition</b> <a href="#l03184">metadata.c:3184</a></div></div>
<div class="ttc" id="ametadata_8c_html_a41bf934e213aad15df933590e6343c3e"><div class="ttname"><a href="metadata_8c.html#a41bf934e213aad15df933590e6343c3e">aaruf_clear_media_title</a></div><div class="ttdeci">int32_t aaruf_clear_media_title(void *context)</div><div class="ttdoc">Clears the media title or label from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l04089">metadata.c:4089</a></div></div>
@@ -2717,7 +2719,6 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
<div class="ttc" id="ametadata_8c_html_a8090a039e00ee003569939332d21094e"><div class="ttname"><a href="metadata_8c.html#a8090a039e00ee003569939332d21094e">aaruf_set_aaru_json_metadata</a></div><div class="ttdeci">int32_t aaruf_set_aaru_json_metadata(void *context, uint8_t *data, size_t length)</div><div class="ttdoc">Sets the Aaru metadata JSON for the image during creation.</div><div class="ttdef"><b>Definition</b> <a href="#l02263">metadata.c:2263</a></div></div>
<div class="ttc" id="ametadata_8c_html_a8652ae4a4cdf400846621d7f497c8b60"><div class="ttname"><a href="metadata_8c.html#a8652ae4a4cdf400846621d7f497c8b60">aaruf_clear_media_part_number</a></div><div class="ttdeci">int32_t aaruf_clear_media_part_number(void *context)</div><div class="ttdoc">Clears the media part number or model designation from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l04515">metadata.c:4515</a></div></div>
<div class="ttc" id="ametadata_8c_html_a878605956a88a3371f4f6e490ee9e2b8"><div class="ttname"><a href="metadata_8c.html#a878605956a88a3371f4f6e490ee9e2b8">aaruf_clear_comments</a></div><div class="ttdeci">int32_t aaruf_clear_comments(void *context)</div><div class="ttdoc">Clears user comments or notes from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l04006">metadata.c:4006</a></div></div>
<div class="ttc" id="ametadata_8c_html_a8e00d26a8e751fbd412868ac4f92a3c0"><div class="ttname"><a href="metadata_8c.html#a8e00d26a8e751fbd412868ac4f92a3c0">aaruf_get_negative_sectors</a></div><div class="ttdeci">int32_t aaruf_get_negative_sectors(const void *context, uint16_t *sectors)</div><div class="ttdoc">Retrieves the number of negative (pre-gap) sectors in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="#l03423">metadata.c:3423</a></div></div>
<div class="ttc" id="ametadata_8c_html_a938d3346f5347dc152b679e6cf619d94"><div class="ttname"><a href="metadata_8c.html#a938d3346f5347dc152b679e6cf619d94">aaruf_clear_media_model</a></div><div class="ttdeci">int32_t aaruf_clear_media_model(void *context)</div><div class="ttdoc">Clears the media model or product designation from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l04257">metadata.c:4257</a></div></div>
<div class="ttc" id="ametadata_8c_html_a9628bcfd2642649a6bcbf1f46d6b6705"><div class="ttname"><a href="metadata_8c.html#a9628bcfd2642649a6bcbf1f46d6b6705">aaruf_get_comments</a></div><div class="ttdeci">int32_t aaruf_get_comments(const void *context, uint8_t *buffer, int32_t *length)</div><div class="ttdoc">Retrieves the user comments or notes stored in the MetadataBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l02482">metadata.c:2482</a></div></div>
<div class="ttc" id="ametadata_8c_html_aa683ff7387ba3f505b1756da1b408f7e"><div class="ttname"><a href="metadata_8c.html#aa683ff7387ba3f505b1756da1b408f7e">aaruf_get_media_sequence</a></div><div class="ttdeci">int32_t aaruf_get_media_sequence(const void *context, int32_t *sequence, int32_t *last_sequence)</div><div class="ttdoc">Retrieves the media sequence metadata for multi-volume image sets.</div><div class="ttdef"><b>Definition</b> <a href="#l02343">metadata.c:2343</a></div></div>
@@ -2731,7 +2732,6 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
<div class="ttc" id="ametadata_8c_html_adaa13a82dfc90987efd6c9a366904dc4"><div class="ttname"><a href="metadata_8c.html#adaa13a82dfc90987efd6c9a366904dc4">aaruf_set_drive_firmware_revision</a></div><div class="ttdeci">int32_t aaruf_set_drive_firmware_revision(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the drive firmware revision for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l01797">metadata.c:1797</a></div></div>
<div class="ttc" id="ametadata_8c_html_add92b8c91ede6a62dfda5f8980c3ce6d"><div class="ttname"><a href="metadata_8c.html#add92b8c91ede6a62dfda5f8980c3ce6d">aaruf_set_media_manufacturer</a></div><div class="ttdeci">int32_t aaruf_set_media_manufacturer(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the media manufacturer information for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l00836">metadata.c:836</a></div></div>
<div class="ttc" id="ametadata_8c_html_ae6b0a57476896bb90ee7bb8472e1078f"><div class="ttname"><a href="metadata_8c.html#ae6b0a57476896bb90ee7bb8472e1078f">aaruf_set_drive_serial_number</a></div><div class="ttdeci">int32_t aaruf_set_drive_serial_number(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the drive serial number for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l01662">metadata.c:1662</a></div></div>
<div class="ttc" id="ametadata_8c_html_aeeae64b120a10bac5e3d757a07a9691a"><div class="ttname"><a href="metadata_8c.html#aeeae64b120a10bac5e3d757a07a9691a">aaruf_get_overflow_sectors</a></div><div class="ttdeci">int32_t aaruf_get_overflow_sectors(const void *context, uint16_t *sectors)</div><div class="ttdoc">Retrieves the number of overflow (post-gap) sectors in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="#l03558">metadata.c:3558</a></div></div>
<div class="ttc" id="ametadata_8c_html_af1ca27c052c6cde38a8d6d71e10936db"><div class="ttname"><a href="metadata_8c.html#af1ca27c052c6cde38a8d6d71e10936db">aaruf_get_media_title</a></div><div class="ttdeci">int32_t aaruf_get_media_title(const void *context, uint8_t *buffer, int32_t *length)</div><div class="ttdoc">Retrieves the media title or label captured during image creation.</div><div class="ttdef"><b>Definition</b> <a href="#l02552">metadata.c:2552</a></div></div>
<div class="ttc" id="ametadata_8c_html_af28837461d12252d8258032e370585ae"><div class="ttname"><a href="metadata_8c.html#af28837461d12252d8258032e370585ae">aaruf_set_creator</a></div><div class="ttdeci">int32_t aaruf_set_creator(void *context, const uint8_t *data, const int32_t length)</div><div class="ttdoc">Sets the creator (person/operator) information for the image.</div><div class="ttdef"><b>Definition</b> <a href="#l00496">metadata.c:496</a></div></div>
<div class="ttc" id="astructAaruMetadataJsonBlockHeader_html_a5e3db5d08dc09206cad6ea1b88b2db7d"><div class="ttname"><a href="structAaruMetadataJsonBlockHeader.html#a5e3db5d08dc09206cad6ea1b88b2db7d">AaruMetadataJsonBlockHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::AaruMetadataJsonBlock.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8h_source.html#l00121">metadata.h:121</a></div></div>
@@ -2745,7 +2745,7 @@ $(function(){initNavTree('metadata_8c_source.html','',''); });
<div class="ttc" id="astructGeometryBlockHeader_html_a38855dea9b1773ea7f6b837c973106d9"><div class="ttname"><a href="structGeometryBlockHeader.html#a38855dea9b1773ea7f6b837c973106d9">GeometryBlockHeader::cylinders</a></div><div class="ttdeci">uint32_t cylinders</div><div class="ttdoc">Number of cylinders.</div><div class="ttdef"><b>Definition</b> <a href="data_8h_source.html#l00093">data.h:93</a></div></div>
<div class="ttc" id="astructGeometryBlockHeader_html_a9ed0a8f6307eb38589ef4502cef533ee"><div class="ttname"><a href="structGeometryBlockHeader.html#a9ed0a8f6307eb38589ef4502cef533ee">GeometryBlockHeader::heads</a></div><div class="ttdeci">uint32_t heads</div><div class="ttdoc">Number of heads (tracks per cylinder).</div><div class="ttdef"><b>Definition</b> <a href="data_8h_source.html#l00094">data.h:94</a></div></div>
<div class="ttc" id="astructGeometryBlockHeader_html_aea5822d390ac6b2a3b8b2c6250046cd6"><div class="ttname"><a href="structGeometryBlockHeader.html#aea5822d390ac6b2a3b8b2c6250046cd6">GeometryBlockHeader::sectorsPerTrack</a></div><div class="ttdeci">uint32_t sectorsPerTrack</div><div class="ttdoc">Number of sectors per track.</div><div class="ttdef"><b>Definition</b> <a href="data_8h_source.html#l00095">data.h:95</a></div></div>
<div class="ttc" id="astructImageInfo_html"><div class="ttname"><a href="structImageInfo.html">ImageInfo</a></div><div class="ttdoc">High-level summary of an opened Aaru image containing metadata and media characteristics.</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00921">aaru.h:922</a></div></div>
<div class="ttc" id="astructImageInfo_html"><div class="ttname"><a href="structImageInfo.html">ImageInfo</a></div><div class="ttdoc">High-level summary of an opened Aaru image containing metadata and media characteristics.</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00931">aaru.h:932</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a0bbbf0b6d7b48ebdc07d4a5e1138044f"><div class="ttname"><a href="structMetadataBlockHeader.html#a0bbbf0b6d7b48ebdc07d4a5e1138044f">MetadataBlockHeader::commentsLength</a></div><div class="ttdeci">uint32_t commentsLength</div><div class="ttdoc">Length in bytes (including null) of comments string.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8h_source.html#l00078">metadata.h:78</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a1359ce7deda764ea267459f3f5906473"><div class="ttname"><a href="structMetadataBlockHeader.html#a1359ce7deda764ea267459f3f5906473">MetadataBlockHeader::mediaSequence</a></div><div class="ttdeci">int32_t mediaSequence</div><div class="ttdoc">Sequence number within a multi-disc / multi-volume set (0-based or 1-based as producer defines).</div><div class="ttdef"><b>Definition</b> <a href="metadata_8h_source.html#l00072">metadata.h:72</a></div></div>
<div class="ttc" id="astructMetadataBlockHeader_html_a16f0be711a2a0ddb48a0f092716e93dc"><div class="ttname"><a href="structMetadataBlockHeader.html#a16f0be711a2a0ddb48a0f092716e93dc">MetadataBlockHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::MetadataBlock.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8h_source.html#l00070">metadata.h:70</a></div></div>