Files
libaaruformat/docs/html/log_8h.html

196 lines
31 KiB
HTML
Raw Normal View History

2025-10-11 01:35:43 +01:00
<!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"/>
2026-10-08 20:15:08 +01:00
<meta name="generator" content="Doxygen 1.18.0"/>
2025-10-11 01:35:43 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/log.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="dynsections.js"></script>
2026-10-08 20:15:08 +01:00
<script type="text/javascript" src="codefolding.js"></script>
2025-10-11 01:35:43 +01:00
<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 -->
2026-10-08 20:15:08 +01:00
<!-- Generated by Doxygen 1.18.0 -->
2025-10-11 01:35:43 +01:00
<script type="text/javascript">
2026-10-08 20:15:08 +01:00
let searchBox = new SearchBox("searchBox", "search/",'.html');
2025-10-11 01:35:43 +01:00
</script>
<script type="text/javascript">
2026-10-08 20:15:08 +01:00
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
"relPath": "",
"generateTreeView": true,
"searchEngine": true,
"serverBasedSearch": false,
"disableIndex": false,
"dynamicMenus": true,
"fullSidebar": false
}
2025-10-11 01:35:43 +01:00
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
2026-10-08 20:15:08 +01:00
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
<ul class="sm sm-dox" id="main-menu">
<li id="searchBoxPos2">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div><!-- main-nav -->
2025-10-11 01:35:43 +01:00
</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>
2026-10-08 20:15:08 +01:00
<div id="splitbar" class="ui-resizable-handle">
2025-10-11 01:35:43 +01:00
</div>
</div>
<script type="text/javascript">
2026-10-08 20:15:08 +01:00
document.addEventListener('DOMContentLoaded',() => { initNavTree('log_8h.html','',''); });
2025-10-11 01:35:43 +01:00
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
2026-10-08 20:15:08 +01:00
<div id="MSearchSelectWindow">
2025-10-11 01:35:43 +01:00
</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">log.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdarg.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
</div>
<p><a href="log_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
2026-04-11 23:17:09 +01:00
<tr class="memitem:a21cc0459b78d5f2d7bd737e5aae1278a" id="r_a21cc0459b78d5f2d7bd737e5aae1278a"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(fmt, ...)</td></tr>
<tr class="memitem:a053d6037d543b84ce59308ce71d15cd1" id="r_a053d6037d543b84ce59308ce71d15cd1"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a053d6037d543b84ce59308ce71d15cd1">FATAL</a>(fmt, ...)</td></tr>
2025-10-11 01:35:43 +01:00
</table>
<a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2>
<a id="a053d6037d543b84ce59308ce71d15cd1" name="a053d6037d543b84ce59308ce71d15cd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a053d6037d543b84ce59308ce71d15cd1">&#9670;&#160;</a></span>FATAL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FATAL</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>fmt</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00040">40</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>
2026-10-08 20:15:08 +01:00
<p class="reference">Referenced by <a class="el" href="metadata__write_8c_source.html#l02238">aaruf_clear_comments()</a>, <a class="el" href="metadata__write_8c_source.html#l02109">aaruf_clear_creator()</a>, <a class="el" href="dpm_8c_source.html#l00172">aaruf_clear_dpm()</a>, <a class="el" href="metadata__write_8c_source.html#l03096">aaruf_clear_drive_firmware_revision()</a>, <a class="el" href="metadata__write_8c_source.html#l02833">aaruf_clear_drive_manufacturer()</a>, <a class="el" href="metadata__write_8c_source.html#l02919">aaruf_clear_drive_model()</a>, <a class="el" href="metadata__write_8c_source.html#l03008">aaruf_clear_drive_serial_number()</a>, <a class="el" href="flux_8c_source.html#l00776">aaruf_clear_flux_captures()</a>, <a class="el" href="metadata__write_8c_source.html#l02661">aaruf_clear_media_barcode()</a>, <a class="el" href="metadata__write_8c_source.html#l02405">aaruf_clear_media_manufacturer()</a>, <a class="el" href="metadata__write_8c_source.html#l02489">aaruf_clear_media_model()</a>, <a class="el" href="metadata__write_8c_source.html#l02747">aaruf_clear_media_part_number()</a>, <a class="el" href="metadata__write_8c_source.html#l01978">aaruf_clear_media_sequence()</a>, <a class="el" href="metadata__write_8c_source.html#l02575">aaruf_clear_media_serial_number()</a>, <a class="el" href="metadata__write_8c_source.html#l02321">aaruf_clear_media_title()</a>, <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="write_8c_source.html#l01569">aaruf_close_current_block()</a>, <a class="el" href="create_8c_source.html#l00291">aaruf_create()</a>, <a class="el" href="metadata_8c_source.html#l00399">aaruf_get_aaru_json_metadata()</a>, <a class="el" href="tape_8c_source.html#l01319">aaruf_get_all_tape_files()</a>, <a class="el" href="tape_8c_source.html#l01421">aaruf_get_all_tape_partitions()</a>, <a class="el" href="metadata_8c_source.html#l00244">aaruf_get_cicm_metadata()</a>, <a class="el" href="metadata_8c_source.html#l00616">aaruf_get_comments()</a>, <a class="el" href="metadata_8c_source.html#l00544">aaruf_get_creator()</a>, <a class="el" href="dpm_8c_source.html#l00043">aaruf_get_dpm()</a>, <a class="el" href="metadata_8c_source.html#l01318">aaruf_get_drive_firmware_revision()</a>, <a class="el" href="metadata_8c_source.html#l01108">aaruf_get_drive_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l01178">aaruf_get_drive_model()</a>, <a class="el" href="metadata_8c_source.html#l01248">aaruf_get_drive_serial_number()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>, <a class="el" href="metadata_8c_source.html#l00104">aaruf_get_geometry()</a>, <a class="el" href="metadata_8c_source.html#l01774">aaruf_get_image_info()</a>, <a class="el" href="metadata_8c_source.html#l00965">aaruf_get_media_barcode()</a>, <a class="el" href="metadata_8c_source.html#l00756">aaruf_get_media_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l00826">aaruf_get_media_model()</a>, <a class="el" href="metadata_8c_source.html#l01036">aaruf_get_media_part_number()</a>, <a class="el" href="metadata_8c_source.html#l00477">aaruf_get_media_sequence()</a>, <a class="el" href="metadata_8c_source.html#l00896">aaruf_get_media_serial_number()</a>, <a class="el" href="metadata_8c_source.html#l00686">aaruf_get_media_title()</a>, <a class="el" href="metadata_8c_source.html#l01557">aaruf_get_negative_sectors()</a>, <a class="el" href="metadata_8c_source.html#l01692">aaruf_get_overflow_sectors()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00715">aaruf_get_readable_media_tags()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00627">aaruf_get_readable_sector_tags()</a>, <a class="el" href="tape_8c_source.html#l00572">aaruf_get_tape_file()</a>, <a class="el" href="tape_8c_source.html#l00986">aaruf_get_tape_partition()</a>, <a class="el" href="optical_8c_source.html#l00317">aaruf_get_tracks()</a>, <a class="el" href="metadata_8c_source.html#l01432">aaruf_get_us
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a21cc0459b78d5f2d7bd737e5aae1278a" name="a21cc0459b78d5f2d7bd737e5aae1278a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21cc0459b78d5f2d7bd737e5aae1278a">&#9670;&#160;</a></span>TRACE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TRACE</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>fmt</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="log_8h_source.html#l00025">25</a> of file <a class="el" href="log_8h_source.html">log.h</a>.</p>
2026-10-08 20:15:08 +01:00
<p class="reference">Referenced by <a class="el" href="ecc__cd_8c_source.html#l00391">aaruf_cd_lba_to_msf()</a>, <a class="el" href="metadata__write_8c_source.html#l02238">aaruf_clear_comments()</a>, <a class="el" href="metadata__write_8c_source.html#l02109">aaruf_clear_creator()</a>, <a class="el" href="dpm_8c_source.html#l00172">aaruf_clear_dpm()</a>, <a class="el" href="metadata__write_8c_source.html#l03096">aaruf_clear_drive_firmware_revision()</a>, <a class="el" href="metadata__write_8c_source.html#l02833">aaruf_clear_drive_manufacturer()</a>, <a class="el" href="metadata__write_8c_source.html#l02919">aaruf_clear_drive_model()</a>, <a class="el" href="metadata__write_8c_source.html#l03008">aaruf_clear_drive_serial_number()</a>, <a class="el" href="flux_8c_source.html#l00776">aaruf_clear_flux_captures()</a>, <a class="el" href="metadata__write_8c_source.html#l02661">aaruf_clear_media_barcode()</a>, <a class="el" href="metadata__write_8c_source.html#l02405">aaruf_clear_media_manufacturer()</a>, <a class="el" href="metadata__write_8c_source.html#l02489">aaruf_clear_media_model()</a>, <a class="el" href="metadata__write_8c_source.html#l02747">aaruf_clear_media_part_number()</a>, <a class="el" href="metadata__write_8c_source.html#l01978">aaruf_clear_media_sequence()</a>, <a class="el" href="metadata__write_8c_source.html#l02575">aaruf_clear_media_serial_number()</a>, <a class="el" href="metadata__write_8c_source.html#l02321">aaruf_clear_media_title()</a>, <a class="el" href="close_8c_source.html#l00080">aaruf_close()</a>, <a class="el" href="write_8c_source.html#l01569">aaruf_close_current_block()</a>, <a class="el" href="crc64_8c_source.html#l00032">aaruf_crc64_init()</a>, <a class="el" href="crc64_8c_source.html#l00055">aaruf_crc64_update()</a>, <a class="el" href="create_8c_source.html#l00291">aaruf_create()</a>, <a class="el" href="ecc__cd_8c_source.html#l00244">aaruf_ecc_cd_check()</a>, <a class="el" href="ecc__cd_8c_source.html#l00035">aaruf_ecc_cd_init()</a>, <a class="el" href="ecc__cd_8c_source.html#l00118">aaruf_ecc_cd_is_suffix_correct()</a>, <a class="el" href="ecc__cd_8c_source.html#l00182">aaruf_ecc_cd_is_suffix_correct_mode2()</a>, <a class="el" href="ecc__cd_8c_source.html#l00476">aaruf_ecc_cd_reconstruct()</a>, <a class="el" href="ecc__cd_8c_source.html#l00409">aaruf_ecc_cd_reconstruct_prefix()</a>, <a class="el" href="ecc__cd_8c_source.html#l00310">aaruf_ecc_cd_write()</a>, <a class="el" href="ecc__cd_8c_source.html#l00369">aaruf_ecc_cd_write_sector()</a>, <a class="el" href="ecc__cd_8c_source.html#l00564">aaruf_edc_cd_compute()</a>, <a class="el" href="close__write_8c_source.html#l05555">aaruf_finalize_write()</a>, <a class="el" href="metadata_8c_source.html#l00399">aaruf_get_aaru_json_metadata()</a>, <a class="el" href="tape_8c_source.html#l01319">aaruf_get_all_tape_files()</a>, <a class="el" href="tape_8c_source.html#l01421">aaruf_get_all_tape_partitions()</a>, <a class="el" href="metadata_8c_source.html#l00244">aaruf_get_cicm_metadata()</a>, <a class="el" href="metadata_8c_source.html#l00616">aaruf_get_comments()</a>, <a class="el" href="metadata_8c_source.html#l00544">aaruf_get_creator()</a>, <a class="el" href="dpm_8c_source.html#l00043">aaruf_get_dpm()</a>, <a class="el" href="metadata_8c_source.html#l01318">aaruf_get_drive_firmware_revision()</a>, <a class="el" href="metadata_8c_source.html#l01108">aaruf_get_drive_manufacturer()</a>, <a class="el" href="metadata_8c_source.html#l01178">aaruf_get_drive_model()</a>, <a class="el" href="metadata_8c_source.html#l01248">aaruf_get_drive_serial_number()</a>, <a class="el" href="dump_8c_source.html#l00186">aaruf_get_dumphw()</a>, <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>, <a class="el" href="metadata_8c_source.html#l00104">aaruf_get_geometry()</a>, <a class="el" href="metadata_8c_source.html#l01774">aaruf_get_image_info()</a>, <a class="el" href="metadata_8c_source.html#l00965">aaruf_get_media_barcode()</a>, <a class="el" href="metadata_8c_source.html#l00756">aaruf_get_media_manufacturer()</a>, <a class="el" href="met
2025-10-11 01:35:43 +01:00
</div>
</div>
</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="log_8h.html">log.h</a></li>
2026-10-08 20:15:08 +01:00
<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.18.0 </li>
2025-10-11 01:35:43 +01:00
</ul>
</div>
</body>
</html>