blob: 9a7f1e906276859187eead7abe769c277ff89376 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
<?xml version='1.0' encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter id="chapter-signals-log">
<title>Log signals</title>
<refsect1 id="logs.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
"<link linkend="logs-log-timestamp">log-timestamp</link>"
</synopsis>
</refsect1>
<refsect1 id="logs.signal-details" role="signals">
<title role="signals.title">Signal details</title>
<refsect2 id="logs-log-timestamp" role="signal">
<title>The <literal>"log-timestamp"</literal> signal</title>
<programlisting>
char * user_function (PurpleLog *log,
time_t when,
gboolean show_date,
gpointer user_data)
</programlisting>
<para>
Emitted to allow plugins to customize the timestamp on a message being logged.
</para>
<note><para>
Plugins must be careful of logs with a type of PURPLE_LOG_SYSTEM.
</para></note>
<variablelist role="params">
<varlistentry>
<term><parameter>log</parameter> :</term>
<listitem><simpara>The log the message belongs to.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>when</parameter> :</term>
<listitem><simpara>The time to be converted to a string.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>show_date</parameter> :</term>
<listitem><simpara>Whether the date should be displayed.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A textual representation of the time, or <literal>NULL</literal> to use a default format.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</chapter>
|
