Debian Codegraph @

docs/api/html/libprelude-prelude-log.html

raw
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>prelude-log: libprelude Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="libprelude Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="libprelude-prelude-io.html" title="prelude-io">
10 <link rel="next" href="libprelude-prelude-msg.html" title="prelude-msg">
11 <meta name="generator" content="GTK-Doc V1.28 (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="5"><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="#libprelude-prelude-log.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="libprelude-prelude-io.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libprelude-prelude-msg.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libprelude-prelude-log"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libprelude-prelude-log.top_of_page"></a>prelude-log</span></h2>
30 <p>prelude-log</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libprelude-prelude-log.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="define_keyword">#define</td>
44 <td class="function_name">
45 <a class="link" href="libprelude-prelude-log.html#prelude-log" title="prelude_log()">prelude_log</a><span class="c_punctuation">()</span>
46 </td>
47 </tr>
48 <tr>
49 <td class="define_keyword">#define</td>
50 <td class="function_name">
51 <a class="link" href="libprelude-prelude-log.html#prelude-log-debug" title="prelude_log_debug()">prelude_log_debug</a><span class="c_punctuation">()</span>
52 </td>
53 </tr>
54 <tr>
55 <td class="define_keyword">#define</td>
56 <td class="function_name">
57 <a class="link" href="libprelude-prelude-log.html#prelude-log-v" title="prelude_log_v()">prelude_log_v</a><span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="define_keyword">#define</td>
62 <td class="function_name">
63 <a class="link" href="libprelude-prelude-log.html#prelude-log-debug-v" title="prelude_log_debug_v()">prelude_log_debug_v</a><span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <span class="returnvalue">void</span>
69 </td>
70 <td class="function_name">
71 <a class="link" href="libprelude-prelude-log.html#prelude-log-set-level" title="prelude_log_set_level ()">prelude_log_set_level</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <span class="returnvalue">void</span>
77 </td>
78 <td class="function_name">
79 <a class="link" href="libprelude-prelude-log.html#prelude-log-set-debug-level" title="prelude_log_set_debug_level ()">prelude_log_set_debug_level</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <a class="link" href="libprelude-prelude-log.html#prelude-log-flags-t" title="enum prelude_log_flags_t"><span class="returnvalue">prelude_log_flags_t</span></a>
85 </td>
86 <td class="function_name">
87 <a class="link" href="libprelude-prelude-log.html#prelude-log-get-flags" title="prelude_log_get_flags ()">prelude_log_get_flags</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <span class="returnvalue">void</span>
93 </td>
94 <td class="function_name">
95 <a class="link" href="libprelude-prelude-log.html#prelude-log-set-flags" title="prelude_log_set_flags ()">prelude_log_set_flags</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <span class="returnvalue">char</span> *
101 </td>
102 <td class="function_name">
103 <a class="link" href="libprelude-prelude-log.html#prelude-log-get-prefix" title="prelude_log_get_prefix ()">prelude_log_get_prefix</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <span class="returnvalue">void</span>
109 </td>
110 <td class="function_name">
111 <a class="link" href="libprelude-prelude-log.html#prelude-log-set-prefix" title="prelude_log_set_prefix ()">prelude_log_set_prefix</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <span class="returnvalue">void</span>
117 </td>
118 <td class="function_name">
119 <a class="link" href="libprelude-prelude-log.html#prelude-log-set-callback" title="prelude_log_set_callback ()">prelude_log_set_callback</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <span class="returnvalue">int</span>
125 </td>
126 <td class="function_name">
127 <a class="link" href="libprelude-prelude-log.html#prelude-log-set-logfile" title="prelude_log_set_logfile ()">prelude_log_set_logfile</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 </tbody>
131 </table></div>
132 </div>
133 <div class="refsect1">
134 <a name="libprelude-prelude-log.other"></a><h2>Types and Values</h2>
135 <div class="informaltable"><table width="100%" border="0">
136 <colgroup>
137 <col width="150px" class="name">
138 <col class="description">
139 </colgroup>
140 <tbody>
141 <tr>
142 <td class="datatype_keyword">enum</td>
143 <td class="function_name"><a class="link" href="libprelude-prelude-log.html#prelude-log-t" title="enum prelude_log_t">prelude_log_t</a></td>
144 </tr>
145 <tr>
146 <td class="datatype_keyword">enum</td>
147 <td class="function_name"><a class="link" href="libprelude-prelude-log.html#prelude-log-flags-t" title="enum prelude_log_flags_t">prelude_log_flags_t</a></td>
148 </tr>
149 </tbody>
150 </table></div>
151 </div>
152 <div class="refsect1">
153 <a name="libprelude-prelude-log.description"></a><h2>Description</h2>
154 </div>
155 <div class="refsect1">
156 <a name="libprelude-prelude-log.functions_details"></a><h2>Functions</h2>
157 <div class="refsect2">
158 <a name="prelude-log"></a><h3>prelude_log()</h3>
159 <pre class="programlisting">#define prelude_log(level, ...)</pre>
160 </div>
161 <hr>
162 <div class="refsect2">
163 <a name="prelude-log-debug"></a><h3>prelude_log_debug()</h3>
164 <pre class="programlisting">#define prelude_log_debug(level, ...)</pre>
165 </div>
166 <hr>
167 <div class="refsect2">
168 <a name="prelude-log-v"></a><h3>prelude_log_v()</h3>
169 <pre class="programlisting">#define prelude_log_v(level, fmt, ap)</pre>
170 </div>
171 <hr>
172 <div class="refsect2">
173 <a name="prelude-log-debug-v"></a><h3>prelude_log_debug_v()</h3>
174 <pre class="programlisting">#define prelude_log_debug_v(level, fmt, ap)</pre>
175 </div>
176 <hr>
177 <div class="refsect2">
178 <a name="prelude-log-set-level"></a><h3>prelude_log_set_level ()</h3>
179 <pre class="programlisting"><span class="returnvalue">void</span>
180 prelude_log_set_level (<em class="parameter"><code><a class="link" href="libprelude-prelude-log.html#prelude-log-t" title="enum prelude_log_t"><span class="type">prelude_log_t</span></a> level</code></em>);</pre>
181 </div>
182 <hr>
183 <div class="refsect2">
184 <a name="prelude-log-set-debug-level"></a><h3>prelude_log_set_debug_level ()</h3>
185 <pre class="programlisting"><span class="returnvalue">void</span>
186 prelude_log_set_debug_level (<em class="parameter"><code><span class="type">int</span> level</code></em>);</pre>
187 </div>
188 <hr>
189 <div class="refsect2">
190 <a name="prelude-log-get-flags"></a><h3>prelude_log_get_flags ()</h3>
191 <pre class="programlisting"><a class="link" href="libprelude-prelude-log.html#prelude-log-flags-t" title="enum prelude_log_flags_t"><span class="returnvalue">prelude_log_flags_t</span></a>
192 prelude_log_get_flags (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
193 </div>
194 <hr>
195 <div class="refsect2">
196 <a name="prelude-log-set-flags"></a><h3>prelude_log_set_flags ()</h3>
197 <pre class="programlisting"><span class="returnvalue">void</span>
198 prelude_log_set_flags (<em class="parameter"><code><a class="link" href="libprelude-prelude-log.html#prelude-log-flags-t" title="enum prelude_log_flags_t"><span class="type">prelude_log_flags_t</span></a> flags</code></em>);</pre>
199 </div>
200 <hr>
201 <div class="refsect2">
202 <a name="prelude-log-get-prefix"></a><h3>prelude_log_get_prefix ()</h3>
203 <pre class="programlisting"><span class="returnvalue">char</span> *
204 prelude_log_get_prefix (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
205 </div>
206 <hr>
207 <div class="refsect2">
208 <a name="prelude-log-set-prefix"></a><h3>prelude_log_set_prefix ()</h3>
209 <pre class="programlisting"><span class="returnvalue">void</span>
210 prelude_log_set_prefix (<em class="parameter"><code><span class="type">char</span> *prefix</code></em>);</pre>
211 <p>Tell the Prelude standard logger to add <em class="parameter"><code>prefix</code></em>
212 before logging
213 a line.</p>
214 <div class="refsect3">
215 <a name="prelude-log-set-prefix.parameters"></a><h4>Parameters</h4>
216 <div class="informaltable"><table width="100%" border="0">
217 <colgroup>
218 <col width="150px" class="parameters_name">
219 <col class="parameters_description">
220 <col width="200px" class="parameters_annotations">
221 </colgroup>
222 <tbody><tr>
223 <td class="parameter_name"><p>prefix</p></td>
224 <td class="parameter_description"><p>Pointer to the prefix to use.</p></td>
225 <td class="parameter_annotations"> </td>
226 </tr></tbody>
227 </table></div>
228 </div>
229 </div>
230 <hr>
231 <div class="refsect2">
232 <a name="prelude-log-set-callback"></a><h3>prelude_log_set_callback ()</h3>
233 <pre class="programlisting"><span class="returnvalue">void</span>
234 prelude_log_set_callback ();</pre>
235 <p><em class="parameter"><code><code class="function">log_cb()</code></code></em>
236 will be called in place of the prelude function usally
237 used for loging.</p>
238 <div class="refsect3">
239 <a name="prelude-log-set-callback.parameters"></a><h4>Parameters</h4>
240 <div class="informaltable"><table width="100%" border="0">
241 <colgroup>
242 <col width="150px" class="parameters_name">
243 <col class="parameters_description">
244 <col width="200px" class="parameters_annotations">
245 </colgroup>
246 <tbody><tr>
247 <td class="parameter_name"><p>log_cb</p></td>
248 <td class="parameter_description"><p>Callback function.</p></td>
249 <td class="parameter_annotations"> </td>
250 </tr></tbody>
251 </table></div>
252 </div>
253 </div>
254 <hr>
255 <div class="refsect2">
256 <a name="prelude-log-set-logfile"></a><h3>prelude_log_set_logfile ()</h3>
257 <pre class="programlisting"><span class="returnvalue">int</span>
258 prelude_log_set_logfile (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
259 </div>
260 </div>
261 <div class="refsect1">
262 <a name="libprelude-prelude-log.other_details"></a><h2>Types and Values</h2>
263 <div class="refsect2">
264 <a name="prelude-log-t"></a><h3>enum prelude_log_t</h3>
265 <div class="refsect3">
266 <a name="prelude-log-t.members"></a><h4>Members</h4>
267 <div class="informaltable"><table width="100%" border="0">
268 <colgroup>
269 <col width="300px" class="enum_members_name">
270 <col class="enum_members_description">
271 <col width="200px" class="enum_members_annotations">
272 </colgroup>
273 <tbody>
274 <tr>
275 <td class="enum_member_name"><p><a name="PRELUDE-LOG-CRIT:CAPS"></a>PRELUDE_LOG_CRIT</p></td>
276 <td> </td>
277 <td> </td>
278 </tr>
279 <tr>
280 <td class="enum_member_name"><p><a name="PRELUDE-LOG-ERR:CAPS"></a>PRELUDE_LOG_ERR</p></td>
281 <td> </td>
282 <td> </td>
283 </tr>
284 <tr>
285 <td class="enum_member_name"><p><a name="PRELUDE-LOG-WARN:CAPS"></a>PRELUDE_LOG_WARN</p></td>
286 <td> </td>
287 <td> </td>
288 </tr>
289 <tr>
290 <td class="enum_member_name"><p><a name="PRELUDE-LOG-INFO:CAPS"></a>PRELUDE_LOG_INFO</p></td>
291 <td> </td>
292 <td> </td>
293 </tr>
294 <tr>
295 <td class="enum_member_name"><p><a name="PRELUDE-LOG-DEBUG:CAPS"></a>PRELUDE_LOG_DEBUG</p></td>
296 <td> </td>
297 <td> </td>
298 </tr>
299 </tbody>
300 </table></div>
301 </div>
302 </div>
303 <hr>
304 <div class="refsect2">
305 <a name="prelude-log-flags-t"></a><h3>enum prelude_log_flags_t</h3>
306 <div class="refsect3">
307 <a name="prelude-log-flags-t.members"></a><h4>Members</h4>
308 <div class="informaltable"><table width="100%" border="0">
309 <colgroup>
310 <col width="300px" class="enum_members_name">
311 <col class="enum_members_description">
312 <col width="200px" class="enum_members_annotations">
313 </colgroup>
314 <tbody>
315 <tr>
316 <td class="enum_member_name"><p><a name="PRELUDE-LOG-FLAGS-QUIET:CAPS"></a>PRELUDE_LOG_FLAGS_QUIET</p></td>
317 <td> </td>
318 <td> </td>
319 </tr>
320 <tr>
321 <td class="enum_member_name"><p><a name="PRELUDE-LOG-FLAGS-SYSLOG:CAPS"></a>PRELUDE_LOG_FLAGS_SYSLOG</p></td>
322 <td> </td>
323 <td> </td>
324 </tr>
325 </tbody>
326 </table></div>
327 </div>
328 </div>
329 </div>
330 </div>
331 <div class="footer">
332 <hr>Generated by GTK-Doc V1.28</div>
333 </body>
334 </html>