← Back to branch summary

~ubuntu-branches/ubuntu/hardy/glib2.0/hardy-updates

« back to all changes in this revision

Viewing changes to docs/reference/glib/html/glib-Message-Logging.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge, Sjoerd Simons, Sebastian Dröge
  • Date: 2008-04-08 12:02:07 UTC
  • mfrom: (1.2.40 upstream)
  • Revision ID: james.westby@ubuntu.com-20080408120207-8a2nownsi3sccoxs
Tags: 2.16.3-1
[ Sjoerd Simons ]
* debian/patches/70_g_timeout_seconds_fix.patch
  + Added. Fix a rare case where a timeout from g_timeout_add_seconds() is
  never triggered. See http://bugzilla.gnome.org/show_bug.cgi?id=448943

[ Sebastian Dröge ]
* New upstream bugfix release:
  + debian/patches/70_g_timeout_seconds_fix.patch:
    - Dropped, merged upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/glib/html/glib-Message-Logging.html
36
36
<th width="100%" align="center">GLib Reference Manual</th>
37
37
<td><a accesskey="n" href="glib-utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
38
38
</tr>
39
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3105971" class="shortcut">Top</a>
 
39
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3013606" class="shortcut">Top</a>
40
40
                  &#160;|&#160;
41
 
                  <a href="#id3106407" class="shortcut">Description</a></nobr></td></tr>
 
41
                  <a href="#id3014042" class="shortcut">Description</a></nobr></td></tr>
42
42
</table>
43
43
<div class="refentry" lang="en">
44
44
<a name="glib-Message-Logging"></a><div class="titlepage"></div>
45
45
<div class="refnamediv"><table width="100%"><tr>
46
46
<td valign="top">
47
47
<h2>
48
 
<a name="id3105971"></a><span class="refentrytitle">Message Logging</span>
 
48
<a name="id3013606"></a><span class="refentrytitle">Message Logging</span>
49
49
</h2>
50
50
<p>Message Logging &#8212; versatile support for logging messages with different levels of importance</p>
51
51
</td>
99
99
</pre>
100
100
</div>
101
101
<div class="refsect1" lang="en">
102
 
<a name="id3106407"></a><h2>Description</h2>
 
102
<a name="id3014042"></a><h2>Description</h2>
103
103
<p>
104
104
These functions provide support for logging error messages or messages 
105
105
used for debugging. 
110
110
</p>
111
111
</div>
112
112
<div class="refsect1" lang="en">
113
 
<a name="id3106437"></a><h2>Details</h2>
 
113
<a name="id3014072"></a><h2>Details</h2>
114
114
<div class="refsect2" lang="en">
115
 
<a name="id3106447"></a><h3>
 
115
<a name="id3014082"></a><h3>
116
116
<a name="G-LOG-DOMAIN:CAPS"></a>G_LOG_DOMAIN</h3>
117
 
<a class="indexterm" name="id3106460"></a><pre class="programlisting">#define G_LOG_DOMAIN    ((gchar*) 0)
 
117
<a class="indexterm" name="id3014095"></a><pre class="programlisting">#define G_LOG_DOMAIN    ((gchar*) 0)
118
118
</pre>
119
119
<p>
120
120
Defines the log domain.
132
132
</div>
133
133
<hr>
134
134
<div class="refsect2" lang="en">
135
 
<a name="id3106502"></a><h3>
 
135
<a name="id3014137"></a><h3>
136
136
<a name="G-LOG-FATAL-MASK:CAPS"></a>G_LOG_FATAL_MASK</h3>
137
 
<a class="indexterm" name="id3106516"></a><pre class="programlisting">#define G_LOG_FATAL_MASK        (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
 
137
<a class="indexterm" name="id3014151"></a><pre class="programlisting">#define G_LOG_FATAL_MASK        (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
138
138
</pre>
139
139
<p>
140
140
GLib log levels that are considered fatal by default.
142
142
</div>
143
143
<hr>
144
144
<div class="refsect2" lang="en">
145
 
<a name="id3106533"></a><h3>
 
145
<a name="id3014168"></a><h3>
146
146
<a name="G-LOG-LEVEL-USER-SHIFT:CAPS"></a>G_LOG_LEVEL_USER_SHIFT</h3>
147
 
<a class="indexterm" name="id3106546"></a><pre class="programlisting">#define G_LOG_LEVEL_USER_SHIFT  (8)
 
147
<a class="indexterm" name="id3014181"></a><pre class="programlisting">#define G_LOG_LEVEL_USER_SHIFT  (8)
148
148
</pre>
149
149
<p>
150
150
Log level shift offset for user defined log levels (0-7 are used by GLib).
152
152
</div>
153
153
<hr>
154
154
<div class="refsect2" lang="en">
155
 
<a name="id3106563"></a><h3>
 
155
<a name="id3014198"></a><h3>
156
156
<a name="GLogFunc"></a>GLogFunc ()</h3>
157
 
<a class="indexterm" name="id3106575"></a><pre class="programlisting">void                (*GLogFunc)                         (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
 
157
<a class="indexterm" name="id3014211"></a><pre class="programlisting">void                (*GLogFunc)                         (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
158
158
                                                         <a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> log_level,
159
159
                                                         const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *message,
160
160
                                                         <a class="link" href="glib-Basic-Types.html#gpointer">gpointer</a> user_data);</pre>
192
192
</div>
193
193
<hr>
194
194
<div class="refsect2" lang="en">
195
 
<a name="id3106701"></a><h3>
 
195
<a name="id3014336"></a><h3>
196
196
<a name="GLogLevelFlags"></a>enum GLogLevelFlags</h3>
197
 
<a class="indexterm" name="id3106714"></a><pre class="programlisting">typedef enum
 
197
<a class="indexterm" name="id3014349"></a><pre class="programlisting">typedef enum
198
198
{
199
199
  /* log flags */
200
200
  G_LOG_FLAG_RECURSION          = 1 &lt;&lt; 0,
273
273
</div>
274
274
<hr>
275
275
<div class="refsect2" lang="en">
276
 
<a name="id3107061"></a><h3>
 
276
<a name="id3014696"></a><h3>
277
277
<a name="g-log"></a>g_log ()</h3>
278
 
<a class="indexterm" name="id3107073"></a><pre class="programlisting">void                g_log                               (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
 
278
<a class="indexterm" name="id3014708"></a><pre class="programlisting">void                g_log                               (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
279
279
                                                         <a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> log_level,
280
280
                                                         const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *format,
281
281
                                                         ...);</pre>
315
315
</div>
316
316
<hr>
317
317
<div class="refsect2" lang="en">
318
 
<a name="id3107220"></a><h3>
 
318
<a name="id3014856"></a><h3>
319
319
<a name="g-logv"></a>g_logv ()</h3>
320
 
<a class="indexterm" name="id3107233"></a><pre class="programlisting">void                g_logv                              (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
 
320
<a class="indexterm" name="id3014868"></a><pre class="programlisting">void                g_logv                              (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
321
321
                                                         <a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> log_level,
322
322
                                                         const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *format,
323
323
                                                         va_list args);</pre>
357
357
</div>
358
358
<hr>
359
359
<div class="refsect2" lang="en">
360
 
<a name="id3107369"></a><h3>
 
360
<a name="id3015004"></a><h3>
361
361
<a name="g-message"></a>g_message()</h3>
362
 
<a class="indexterm" name="id3107381"></a><pre class="programlisting">#define             g_message(...)</pre>
 
362
<a class="indexterm" name="id3015016"></a><pre class="programlisting">#define             g_message(...)</pre>
363
363
<p>
364
364
A convenience function/macro to log a normal message.
365
365
</p>
376
376
</div>
377
377
<hr>
378
378
<div class="refsect2" lang="en">
379
 
<a name="id3107427"></a><h3>
 
379
<a name="id3015062"></a><h3>
380
380
<a name="g-warning"></a>g_warning()</h3>
381
 
<a class="indexterm" name="id3107439"></a><pre class="programlisting">#define             g_warning(...)</pre>
 
381
<a class="indexterm" name="id3015075"></a><pre class="programlisting">#define             g_warning(...)</pre>
382
382
<p>
383
383
A convenience function/macro to log a warning message.
384
384
</p>
399
399
</div>
400
400
<hr>
401
401
<div class="refsect2" lang="en">
402
 
<a name="id3107508"></a><h3>
 
402
<a name="id3015143"></a><h3>
403
403
<a name="g-critical"></a>g_critical()</h3>
404
 
<a class="indexterm" name="id3107520"></a><pre class="programlisting">#define             g_critical(...)</pre>
 
404
<a class="indexterm" name="id3015156"></a><pre class="programlisting">#define             g_critical(...)</pre>
405
405
<p>
406
406
Logs a "critical warning" (<a class="link" href="glib-Message-Logging.html#G-LOG-LEVEL-CRITICAL:CAPS"><span class="type">G_LOG_LEVEL_CRITICAL</span></a>). It's more or less
407
407
application-defined what constitutes a critical vs. a regular
427
427
</div>
428
428
<hr>
429
429
<div class="refsect2" lang="en">
430
 
<a name="id3107621"></a><h3>
 
430
<a name="id3015256"></a><h3>
431
431
<a name="g-error"></a>g_error()</h3>
432
 
<a class="indexterm" name="id3107634"></a><pre class="programlisting">#define             g_error(...)</pre>
 
432
<a class="indexterm" name="id3015269"></a><pre class="programlisting">#define             g_error(...)</pre>
433
433
<p>
434
434
A convenience function/macro to log an error message.
435
435
Error messages are always fatal, resulting in a call to
451
451
</div>
452
452
<hr>
453
453
<div class="refsect2" lang="en">
454
 
<a name="id3107694"></a><h3>
 
454
<a name="id3015329"></a><h3>
455
455
<a name="g-debug"></a>g_debug()</h3>
456
 
<a class="indexterm" name="id3107708"></a><pre class="programlisting">#define             g_debug(...)</pre>
 
456
<a class="indexterm" name="id3015344"></a><pre class="programlisting">#define             g_debug(...)</pre>
457
457
<p>
458
458
A convenience function/macro to log a debug message.
459
459
</p>
472
472
</div>
473
473
<hr>
474
474
<div class="refsect2" lang="en">
475
 
<a name="id3107761"></a><h3>
 
475
<a name="id3015396"></a><h3>
476
476
<a name="g-log-set-handler"></a>g_log_set_handler ()</h3>
477
 
<a class="indexterm" name="id3107774"></a><pre class="programlisting"><a class="link" href="glib-Basic-Types.html#guint">guint</a>               g_log_set_handler                   (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
 
477
<a class="indexterm" name="id3015410"></a><pre class="programlisting"><a class="link" href="glib-Basic-Types.html#guint">guint</a>               g_log_set_handler                   (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
478
478
                                                         <a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> log_levels,
479
479
                                                         <a class="link" href="glib-Message-Logging.html#GLogFunc">GLogFunc</a> log_func,
480
480
                                                         <a class="link" href="glib-Basic-Types.html#gpointer">gpointer</a> user_data);</pre>
490
490
<a class="link" href="glib-Message-Logging.html#G-LOG-FLAG-FATAL:CAPS"><span class="type">G_LOG_FLAG_FATAL</span></a>.
491
491
</p>
492
492
<div class="example">
493
 
<a name="id3107879"></a><p class="title"><b>Example&#160;12.&#160;Adding a log handler for all warning messages in the default 
 
493
<a name="id3015514"></a><p class="title"><b>Example&#160;12.&#160;Adding a log handler for all warning messages in the default 
494
494
(application) domain</b></p>
495
495
<div class="example-contents"><pre class="programlisting">
496
496
  g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
498
498
</pre></div>
499
499
</div>
500
500
<br class="example-break"><div class="example">
501
 
<a name="id3107895"></a><p class="title"><b>Example&#160;13.&#160;Adding a log handler for all critical messages from GTK+</b></p>
 
501
<a name="id3015530"></a><p class="title"><b>Example&#160;13.&#160;Adding a log handler for all critical messages from GTK+</b></p>
502
502
<div class="example-contents"><pre class="programlisting">
503
503
  g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL
504
504
                     | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
505
505
</pre></div>
506
506
</div>
507
507
<br class="example-break"><div class="example">
508
 
<a name="id3107910"></a><p class="title"><b>Example&#160;14.&#160;Adding a log handler for <span class="emphasis"><em>all</em></span> messages from 
 
508
<a name="id3015545"></a><p class="title"><b>Example&#160;14.&#160;Adding a log handler for <span class="emphasis"><em>all</em></span> messages from 
509
509
GLib</b></p>
510
510
<div class="example-contents"><pre class="programlisting">
511
511
  g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL
549
549
</div>
550
550
<hr>
551
551
<div class="refsect2" lang="en">
552
 
<a name="id3108030"></a><h3>
 
552
<a name="id3015665"></a><h3>
553
553
<a name="g-log-remove-handler"></a>g_log_remove_handler ()</h3>
554
 
<a class="indexterm" name="id3108043"></a><pre class="programlisting">void                g_log_remove_handler                (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
 
554
<a class="indexterm" name="id3015678"></a><pre class="programlisting">void                g_log_remove_handler                (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
555
555
                                                         <a class="link" href="glib-Basic-Types.html#guint">guint</a> handler_id);</pre>
556
556
<p>
557
557
Removes the log handler.
576
576
</div>
577
577
<hr>
578
578
<div class="refsect2" lang="en">
579
 
<a name="id3108123"></a><h3>
 
579
<a name="id3015759"></a><h3>
580
580
<a name="g-log-set-always-fatal"></a>g_log_set_always_fatal ()</h3>
581
 
<a class="indexterm" name="id3108137"></a><pre class="programlisting"><a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a>      g_log_set_always_fatal              (<a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> fatal_mask);</pre>
 
581
<a class="indexterm" name="id3015772"></a><pre class="programlisting"><a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a>      g_log_set_always_fatal              (<a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> fatal_mask);</pre>
582
582
<p>
583
583
Sets the message levels which are always fatal, in any log domain.
584
584
When a message with any of these levels is logged the program terminates.
611
611
</div>
612
612
<hr>
613
613
<div class="refsect2" lang="en">
614
 
<a name="id3108232"></a><h3>
 
614
<a name="id3015867"></a><h3>
615
615
<a name="g-log-set-fatal-mask"></a>g_log_set_fatal_mask ()</h3>
616
 
<a class="indexterm" name="id3108245"></a><pre class="programlisting"><a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a>      g_log_set_fatal_mask                (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
 
616
<a class="indexterm" name="id3015880"></a><pre class="programlisting"><a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a>      g_log_set_fatal_mask                (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
617
617
                                                         <a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> fatal_mask);</pre>
618
618
<p>
619
619
Sets the log levels which are fatal in the given domain.
644
644
</div>
645
645
<hr>
646
646
<div class="refsect2" lang="en">
647
 
<a name="id3108338"></a><h3>
 
647
<a name="id3015973"></a><h3>
648
648
<a name="g-log-default-handler"></a>g_log_default_handler ()</h3>
649
 
<a class="indexterm" name="id3108351"></a><pre class="programlisting">void                g_log_default_handler               (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
 
649
<a class="indexterm" name="id3015986"></a><pre class="programlisting">void                g_log_default_handler               (const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *log_domain,
650
650
                                                         <a class="link" href="glib-Message-Logging.html#GLogLevelFlags">GLogLevelFlags</a> log_level,
651
651
                                                         const <a class="link" href="glib-Basic-Types.html#gchar">gchar</a> *message,
652
652
                                                         <a class="link" href="glib-Basic-Types.html#gpointer">gpointer</a> unused_data);</pre>
691
691
</div>
692
692
<hr>
693
693
<div class="refsect2" lang="en">
694
 
<a name="id3108550"></a><h3>
 
694
<a name="id3016185"></a><h3>
695
695
<a name="g-log-set-default-handler"></a>g_log_set_default_handler ()</h3>
696
 
<a class="indexterm" name="id3108566"></a><pre class="programlisting"><a class="link" href="glib-Message-Logging.html#GLogFunc">GLogFunc</a>            g_log_set_default_handler           (<a class="link" href="glib-Message-Logging.html#GLogFunc">GLogFunc</a> log_func,
 
696
<a class="indexterm" name="id3016201"></a><pre class="programlisting"><a class="link" href="glib-Message-Logging.html#GLogFunc">GLogFunc</a>            g_log_set_default_handler           (<a class="link" href="glib-Message-Logging.html#GLogFunc">GLogFunc</a> log_func,
697
697
                                                         <a class="link" href="glib-Basic-Types.html#gpointer">gpointer</a> user_data);</pre>
698
698
<p>
699
699
Installs a default log handler which is used if no 
728
728
</div>
729
729
</div>
730
730
<div class="refsect1" lang="en">
731
 
<a name="id3108667"></a><div class="refsect2" lang="en"><a name="id3108668"></a></div>
 
731
<a name="id3016303"></a><div class="refsect2" lang="en"><a name="id3016304"></a></div>
732
732
<hr>
733
 
<div class="refsect2" lang="en"><a name="id3108670"></a></div>
 
733
<div class="refsect2" lang="en"><a name="id3016305"></a></div>
734
734
</div>
735
735
</div>
736
736
</body>