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>Logging</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch06.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.19.1 (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">
  17 <a href="#" class="shortcut">Top</a>
  18                    |
  19                   <a href="#gsignond-Logging.description" class="shortcut">Description</a>
  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="ch06.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 valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsynopsisdiv">
  36 <a name="gsignond-Logging.synopsis"></a><h2>Synopsis</h2>
  37 <pre class="synopsis">
  38 #include &lt;gsignond/gsignond-log.h&gt;
  39
  40 #define             <a class="link" href="gsignond-Logging.html#DBG:CAPS" title="DBG()">DBG</a>                                 (frmt,
  41                                                          ...)
  42 #define             <a class="link" href="gsignond-Logging.html#ERR:CAPS" title="ERR()">ERR</a>                                 (frmt,
  43                                                          ...)
  44 #define             <a class="link" href="gsignond-Logging.html#INFO:CAPS" title="INFO()">INFO</a>                                (frmt,
  45                                                          ...)
  46 #define             <a class="link" href="gsignond-Logging.html#TRACEBACK:CAPS" title="TRACEBACK">TRACEBACK</a>
  47 #define             <a class="link" href="gsignond-Logging.html#WARN:CAPS" title="WARN()">WARN</a>                                (frmt,
  48                                                          ...)
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="gsignond-Logging.description"></a><h2>Description</h2>
  53 <p>
  54 <code class="filename">gsignond/gsignond-log.h</code> file contains logging macros
  55 that plugins and extensions should use for debugging and tracing.
  56 </p>
  57 <p>
  58 For example:
  59 </p>
  60 <div class="informalexample">
  61   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  62     <tbody>
  63       <tr>
  64         <td class="listing_lines" align="right"><pre>1</pre></td>
  65         <td class="listing_code"><pre class="programlisting">INFO(<span class="number">&quot;Plugin </span><span class="symbol">%s</span><span class="number"> initialized&quot;</span>, plugin_mechanism);</pre></td>
  66       </tr>
  67     </tbody>
  68   </table>
  69 </div>
  70
  71 <p>
  72 </p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="gsignond-Logging.details"></a><h2>Details</h2>
  76 <div class="refsect2">
  77 <a name="DBG:CAPS"></a><h3>DBG()</h3>
  78 <pre class="programlisting">#define             DBG(frmt, args...)</pre>
  79 <p>
  80 Use this macro to log debug messages. GSignond will take care of
  81 correctly saving them.
  82 </p>
  83 <div class="variablelist"><table border="0">
  84 <col align="left" valign="top">
  85 <tbody>
  86 <tr>
  87 <td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
  88 <td>format string for the message</td>
  89 </tr>
  90 <tr>
  91 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
  92 <td>arguments for the format string</td>
  93 </tr>
  94 </tbody>
  95 </table></div>
  96 </div>
  97 <hr>
  98 <div class="refsect2">
  99 <a name="ERR:CAPS"></a><h3>ERR()</h3>
 100 <pre class="programlisting">#define             ERR(frmt, args...)</pre>
 101 <p>
 102 Use this macro to log error messages. GSignond will take care of
 103 correctly saving them.
 104 </p>
 105 <div class="variablelist"><table border="0">
 106 <col align="left" valign="top">
 107 <tbody>
 108 <tr>
 109 <td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
 110 <td>format string for the message</td>
 111 </tr>
 112 <tr>
 113 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 114 <td>arguments for the format string</td>
 115 </tr>
 116 </tbody>
 117 </table></div>
 118 </div>
 119 <hr>
 120 <div class="refsect2">
 121 <a name="INFO:CAPS"></a><h3>INFO()</h3>
 122 <pre class="programlisting">#define             INFO(frmt, args...)</pre>
 123 <p>
 124 Use this macro to log informational messages. GSignond will take care of
 125 correctly saving them.
 126 </p>
 127 <div class="variablelist"><table border="0">
 128 <col align="left" valign="top">
 129 <tbody>
 130 <tr>
 131 <td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
 132 <td>format string for the message</td>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 136 <td>arguments for the format string</td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <hr>
 142 <div class="refsect2">
 143 <a name="TRACEBACK:CAPS"></a><h3>TRACEBACK</h3>
 144 <pre class="programlisting">#define             TRACEBACK()</pre>
 145 <p>
 146 This macro prints the current function call stack to stderr.
 147 </p>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="WARN:CAPS"></a><h3>WARN()</h3>
 152 <pre class="programlisting">#define             WARN(frmt, args...)</pre>
 153 <p>
 154 Use this macro to log warning messages. GSignond will take care of
 155 correctly saving them.
 156 </p>
 157 <div class="variablelist"><table border="0">
 158 <col align="left" valign="top">
 159 <tbody>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>frmt</code></em> :</span></p></td>
 162 <td>format string for the message</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 166 <td>arguments for the format string</td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 </div>
 171 </div>
 172 </div>
 173 <div class="footer">
 174 <hr>
 175           Generated by GTK-Doc V1.19.1</div>
 176 </body>
 177 </html>