2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
<!ENTITY version SYSTEM "version.xml">
6
<refentry id="libempathy-empathy-time">
8
<refentrytitle role="top_of_page" id="libempathy-empathy-time.top_of_page">empathy-time</refentrytitle>
9
<manvolnum>3</manvolnum>
10
<refmiscinfo>LIBEMPATHY Library</refmiscinfo>
14
<refname>empathy-time</refname>
15
<refpurpose></refpurpose>
18
<refsynopsisdiv id="libempathy-empathy-time.synopsis" role="synopsis">
19
<title role="synopsis.title">Synopsis</title>
22
#define <link linkend="EMPATHY-TIME-FORMAT-DISPLAY-SHORT--CAPS">EMPATHY_TIME_FORMAT_DISPLAY_SHORT</link>
23
#define <link linkend="EMPATHY-TIME-FORMAT-DISPLAY-LONG--CAPS">EMPATHY_TIME_FORMAT_DISPLAY_LONG</link>
24
<link linkend="time-t">time_t</link> <link linkend="empathy-time-get-current">empathy_time_get_current</link> (void);
25
<link linkend="time-t">time_t</link> <link linkend="empathy-time-get-local-time">empathy_time_get_local_time</link> (<link linkend="struct-tm">struct tm</link> *tm);
26
<link linkend="time-t">time_t</link> <link linkend="empathy-time-parse">empathy_time_parse</link> (const <link linkend="gchar">gchar</link> *str);
27
<link linkend="gchar">gchar</link> * <link linkend="empathy-time-to-string-utc">empathy_time_to_string_utc</link> (<link linkend="time-t">time_t</link> t,
28
const <link linkend="gchar">gchar</link> *format);
29
<link linkend="gchar">gchar</link> * <link linkend="empathy-time-to-string-local">empathy_time_to_string_local</link> (<link linkend="time-t">time_t</link> t,
30
const <link linkend="gchar">gchar</link> *format);
42
<refsect1 id="libempathy-empathy-time.description" role="desc">
43
<title role="desc.title">Description</title>
48
<refsect1 id="libempathy-empathy-time.details" role="details">
49
<title role="details.title">Details</title>
50
<refsect2 id="EMPATHY-TIME-FORMAT-DISPLAY-SHORT--CAPS" role="macro">
51
<title>EMPATHY_TIME_FORMAT_DISPLAY_SHORT</title>
52
<indexterm zone="EMPATHY-TIME-FORMAT-DISPLAY-SHORT--CAPS"><primary sortas="EMPATHY_TIME_FORMAT_DISPLAY_SHORT">EMPATHY_TIME_FORMAT_DISPLAY_SHORT</primary></indexterm><programlisting>#define EMPATHY_TIME_FORMAT_DISPLAY_SHORT "%H:%M"
56
<refsect2 id="EMPATHY-TIME-FORMAT-DISPLAY-LONG--CAPS" role="macro">
57
<title>EMPATHY_TIME_FORMAT_DISPLAY_LONG</title>
58
<indexterm zone="EMPATHY-TIME-FORMAT-DISPLAY-LONG--CAPS"><primary sortas="EMPATHY_TIME_FORMAT_DISPLAY_LONG">EMPATHY_TIME_FORMAT_DISPLAY_LONG</primary></indexterm><programlisting>#define EMPATHY_TIME_FORMAT_DISPLAY_LONG "%a %d %b %Y"
62
<refsect2 id="empathy-time-get-current" role="function">
63
<title>empathy_time_get_current ()</title>
64
<indexterm zone="empathy-time-get-current"><primary sortas="empathy_time_get_current">empathy_time_get_current</primary></indexterm><programlisting><link linkend="time-t">time_t</link> empathy_time_get_current (void);</programlisting>
66
</para><variablelist role="params">
67
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
68
</simpara></listitem></varlistentry>
69
</variablelist></refsect2>
70
<refsect2 id="empathy-time-get-local-time" role="function">
71
<title>empathy_time_get_local_time ()</title>
72
<indexterm zone="empathy-time-get-local-time"><primary sortas="empathy_time_get_local_time">empathy_time_get_local_time</primary></indexterm><programlisting><link linkend="time-t">time_t</link> empathy_time_get_local_time (<link linkend="struct-tm">struct tm</link> *tm);</programlisting>
74
</para><variablelist role="params">
75
<varlistentry><term><parameter>tm</parameter> :</term>
77
</simpara></listitem></varlistentry>
78
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
79
</simpara></listitem></varlistentry>
80
</variablelist></refsect2>
81
<refsect2 id="empathy-time-parse" role="function">
82
<title>empathy_time_parse ()</title>
83
<indexterm zone="empathy-time-parse"><primary sortas="empathy_time_parse">empathy_time_parse</primary></indexterm><programlisting><link linkend="time-t">time_t</link> empathy_time_parse (const <link linkend="gchar">gchar</link> *str);</programlisting>
85
</para><variablelist role="params">
86
<varlistentry><term><parameter>str</parameter> :</term>
88
</simpara></listitem></varlistentry>
89
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
90
</simpara></listitem></varlistentry>
91
</variablelist></refsect2>
92
<refsect2 id="empathy-time-to-string-utc" role="function">
93
<title>empathy_time_to_string_utc ()</title>
94
<indexterm zone="empathy-time-to-string-utc"><primary sortas="empathy_time_to_string_utc">empathy_time_to_string_utc</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * empathy_time_to_string_utc (<link linkend="time-t">time_t</link> t,
95
const <link linkend="gchar">gchar</link> *format);</programlisting>
97
</para><variablelist role="params">
98
<varlistentry><term><parameter>t</parameter> :</term>
100
</simpara></listitem></varlistentry>
101
<varlistentry><term><parameter>format</parameter> :</term>
103
</simpara></listitem></varlistentry>
104
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
105
</simpara></listitem></varlistentry>
106
</variablelist></refsect2>
107
<refsect2 id="empathy-time-to-string-local" role="function">
108
<title>empathy_time_to_string_local ()</title>
109
<indexterm zone="empathy-time-to-string-local"><primary sortas="empathy_time_to_string_local">empathy_time_to_string_local</primary></indexterm><programlisting><link linkend="gchar">gchar</link> * empathy_time_to_string_local (<link linkend="time-t">time_t</link> t,
110
const <link linkend="gchar">gchar</link> *format);</programlisting>
112
</para><variablelist role="params">
113
<varlistentry><term><parameter>t</parameter> :</term>
115
</simpara></listitem></varlistentry>
116
<varlistentry><term><parameter>format</parameter> :</term>
118
</simpara></listitem></varlistentry>
119
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
120
</simpara></listitem></varlistentry>
121
</variablelist></refsect2>