docs/html/gsignond-Logging.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsignond API Reference Manual: Logging</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch07.html" title="Miscellaneous">
   9 <link rel="prev" href="gsignond-Errors.html" title="Errors">
  10 <link rel="next" href="gsignond-Utility-functions.html" title="Utility functions">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#gsignond-Logging.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#gsignond-Logging.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch07.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="gsignond-Errors.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gsignond-Utility-functions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="gsignond-Logging"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="gsignond-Logging.top_of_page"></a>Logging</span></h2>
  31 <p>Logging — logging facilities</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="gsignond-Logging.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="define_keyword">#define</td>
  45 <td class="function_name"><a class="link" href="gsignond-Logging.html#TRACEBACK:CAPS" title="TRACEBACK">TRACEBACK</a></td>
  46 </tr>
  47 <tr>
  48 <td class="define_keyword">#define</td>
  49 <td class="function_name">
  50 <a class="link" href="gsignond-Logging.html#INFO:CAPS" title="INFO()">INFO</a><span class="c_punctuation">()</span>
  51 </td>
  52 </tr>
  53 <tr>
  54 <td class="define_keyword">#define</td>
  55 <td class="function_name">
  56 <a class="link" href="gsignond-Logging.html#ERR:CAPS" title="ERR()">ERR</a><span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="define_keyword">#define</td>
  61 <td class="function_name">
  62 <a class="link" href="gsignond-Logging.html#WARN:CAPS" title="WARN()">WARN</a><span class="c_punctuation">()</span>
  63 </td>
  64 </tr>
  65 <tr>
  66 <td class="define_keyword">#define</td>
  67 <td class="function_name">
  68 <a class="link" href="gsignond-Logging.html#DBG:CAPS" title="DBG()">DBG</a><span class="c_punctuation">()</span>
  69 </td>
  70 </tr>
  71 </tbody>
  72 </table></div>
  73 </div>
  74 <div class="refsect1">
  75 <a name="gsignond-Logging.object-hierarchy"></a><h2>Object Hierarchy</h2>
  76 <pre class="screen">
  77 </pre>
  78 </div>
  79 <div class="refsect1">
  80 <a name="gsignond-Logging.includes"></a><h2>Includes</h2>
  81 <pre class="synopsis">#include &lt;gsignond/gsignond-log.h&gt;
  82 </pre>
  83 </div>
  84 <div class="refsect1">
  85 <a name="gsignond-Logging.description"></a><h2>Description</h2>
  86 <p><code class="filename">gsignond/gsignond-log.h</code> file contains logging macros
  87 that plugins and extensions should use for debugging and tracing.</p>
  88 <p>For example:</p>
  89 <div class="informalexample">
  90   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  91     <tbody>
  92       <tr>
  93         <td class="listing_lines" align="right"><pre>1</pre></td>
  94         <td class="listing_code"><pre class="programlisting"></pre></td>
  95       </tr>
  96     </tbody>
  97   </table>
  98 </div>
  99
 100 </div>
 101 <div class="refsect1">
 102 <a name="gsignond-Logging.functions_details"></a><h2>Functions</h2>
 103 <div class="refsect2">
 104 <a name="TRACEBACK:CAPS"></a><h3>TRACEBACK</h3>
 105 <pre class="programlisting">#define             TRACEBACK()</pre>
 106 <p>This macro prints the current function call stack to stderr.</p>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="INFO:CAPS"></a><h3>INFO()</h3>
 111 <pre class="programlisting">#define             INFO(frmt, args...)</pre>
 112 <p>Use this macro to log informational messages. GSignond will take care of
 113 correctly saving them.</p>
 114 <div class="refsect3">
 115 <a name="id-1.8.3.7.3.5"></a><h4>Parameters</h4>
 116 <div class="informaltable"><table width="100%" border="0">
 117 <colgroup>
 118 <col width="150px" class="parameters_name">
 119 <col class="parameters_description">
 120 <col width="200px" class="parameters_annotations">
 121 </colgroup>
 122 <tbody>
 123 <tr>
 124 <td class="parameter_name"><p>frmt</p></td>
 125 <td class="parameter_description"><p>format string for the message</p></td>
 126 <td class="parameter_annotations"> </td>
 127 </tr>
 128 <tr>
 129 <td class="parameter_name"><p>...</p></td>
 130 <td class="parameter_description"><p>arguments for the format string</p></td>
 131 <td class="parameter_annotations"> </td>
 132 </tr>
 133 </tbody>
 134 </table></div>
 135 </div>
 136 </div>
 137 <hr>
 138 <div class="refsect2">
 139 <a name="ERR:CAPS"></a><h3>ERR()</h3>
 140 <pre class="programlisting">#define             ERR(frmt, args...)</pre>
 141 <p>Use this macro to log error messages. GSignond will take care of
 142 correctly saving them.</p>
 143 <div class="refsect3">
 144 <a name="id-1.8.3.7.4.5"></a><h4>Parameters</h4>
 145 <div class="informaltable"><table width="100%" border="0">
 146 <colgroup>
 147 <col width="150px" class="parameters_name">
 148 <col class="parameters_description">
 149 <col width="200px" class="parameters_annotations">
 150 </colgroup>
 151 <tbody>
 152 <tr>
 153 <td class="parameter_name"><p>frmt</p></td>
 154 <td class="parameter_description"><p>format string for the message</p></td>
 155 <td class="parameter_annotations"> </td>
 156 </tr>
 157 <tr>
 158 <td class="parameter_name"><p>...</p></td>
 159 <td class="parameter_description"><p>arguments for the format string</p></td>
 160 <td class="parameter_annotations"> </td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="WARN:CAPS"></a><h3>WARN()</h3>
 169 <pre class="programlisting">#define             WARN(frmt, args...)</pre>
 170 <p>Use this macro to log warning messages. GSignond will take care of
 171 correctly saving them.</p>
 172 <div class="refsect3">
 173 <a name="id-1.8.3.7.5.5"></a><h4>Parameters</h4>
 174 <div class="informaltable"><table width="100%" border="0">
 175 <colgroup>
 176 <col width="150px" class="parameters_name">
 177 <col class="parameters_description">
 178 <col width="200px" class="parameters_annotations">
 179 </colgroup>
 180 <tbody>
 181 <tr>
 182 <td class="parameter_name"><p>frmt</p></td>
 183 <td class="parameter_description"><p>format string for the message</p></td>
 184 <td class="parameter_annotations"> </td>
 185 </tr>
 186 <tr>
 187 <td class="parameter_name"><p>...</p></td>
 188 <td class="parameter_description"><p>arguments for the format string</p></td>
 189 <td class="parameter_annotations"> </td>
 190 </tr>
 191 </tbody>
 192 </table></div>
 193 </div>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="DBG:CAPS"></a><h3>DBG()</h3>
 198 <pre class="programlisting">#define             DBG(frmt, args...)</pre>
 199 <p>Use this macro to log debug messages. GSignond will take care of
 200 correctly saving them.</p>
 201 <div class="refsect3">
 202 <a name="id-1.8.3.7.6.5"></a><h4>Parameters</h4>
 203 <div class="informaltable"><table width="100%" border="0">
 204 <colgroup>
 205 <col width="150px" class="parameters_name">
 206 <col class="parameters_description">
 207 <col width="200px" class="parameters_annotations">
 208 </colgroup>
 209 <tbody>
 210 <tr>
 211 <td class="parameter_name"><p>frmt</p></td>
 212 <td class="parameter_description"><p>format string for the message</p></td>
 213 <td class="parameter_annotations"> </td>
 214 </tr>
 215 <tr>
 216 <td class="parameter_name"><p>...</p></td>
 217 <td class="parameter_description"><p>arguments for the format string</p></td>
 218 <td class="parameter_annotations"> </td>
 219 </tr>
 220 </tbody>
 221 </table></div>
 222 </div>
 223 </div>
 224 </div>
 225 <div class="refsect1">
 226 <a name="gsignond-Logging.other_details"></a><h2>Types and Values</h2>
 227 </div>
 228 </div>
 229 <div class="footer">
 230 <hr>
 231           Generated by GTK-Doc V1.20</div>
 232 </body>
 233 </html>