~ubuntu-branches/ubuntu/precise/evolution-data-server/precise-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/libedataserver-e-util.html

  • Committer: Bazaar Package Importer
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-07-27 11:45:30 UTC
  • mfrom: (1.1.90 upstream)
  • Revision ID: james.westby@ubuntu.com-20110727114530-v4ntbu728os68b0b
Tags: 3.1.4-0ubuntu1
* New upstream version.
* debian/patches/999git_EDS_3_1_3_1_to_f94a069.patch: drop, included in
  the upstream 3.1.4 tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Utility Functions</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
9
9
<link rel="prev" href="libedataserver-e-uid.html" title="User ID Generation">
10
10
<link rel="next" href="libedataserver-e-url.html" title="EUrl">
11
 
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
38
38
<div class="refsynopsisdiv">
39
39
<a name="libedataserver-e-util.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">struct              <a class="link" href="libedataserver-e-util.html#tm" title="struct tm">tm</a>;
41
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-get-user-cache-dir" title="e_get_user_cache_dir ()">e_get_user_cache_dir</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
42
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-get-user-config-dir" title="e_get_user_config_dir ()">e_get_user_config_dir</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
43
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-get-user-data-dir" title="e_get_user_data_dir ()">e_get_user_data_dir</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
44
 
<span class="returnvalue">gchar</span> *             <a class="link" href="libedataserver-e-util.html#e-util-strstrcase" title="e_util_strstrcase ()">e_util_strstrcase</a>                   (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
 
41
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-get-user-cache-dir" title="e_get_user_cache_dir ()">e_get_user_cache_dir</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
 
42
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-get-user-config-dir" title="e_get_user_config_dir ()">e_get_user_config_dir</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
 
43
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-get-user-data-dir" title="e_get_user_data_dir ()">e_get_user_data_dir</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
 
44
<span class="returnvalue">gchar</span> *                           <a class="link" href="libedataserver-e-util.html#e-util-strstrcase" title="e_util_strstrcase ()">e_util_strstrcase</a>                   (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
45
45
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);
46
 
<span class="returnvalue">gchar</span> *             <a class="link" href="libedataserver-e-util.html#e-util-unicode-get-utf8" title="e_util_unicode_get_utf8 ()">e_util_unicode_get_utf8</a>             (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 
46
<span class="returnvalue">gchar</span> *                           <a class="link" href="libedataserver-e-util.html#e-util-unicode-get-utf8" title="e_util_unicode_get_utf8 ()">e_util_unicode_get_utf8</a>             (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
47
47
                                                         <em class="parameter"><code><span class="type">gunichar</span> *out</code></em>);
48
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-util-utf8-strstrcase" title="e_util_utf8_strstrcase ()">e_util_utf8_strstrcase</a>              (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
 
48
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-util-utf8-strstrcase" title="e_util_utf8_strstrcase ()">e_util_utf8_strstrcase</a>              (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
49
49
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);
50
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-util-utf8-strstrcasedecomp" title="e_util_utf8_strstrcasedecomp ()">e_util_utf8_strstrcasedecomp</a>        (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
 
50
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-util-utf8-strstrcasedecomp" title="e_util_utf8_strstrcasedecomp ()">e_util_utf8_strstrcasedecomp</a>        (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
51
51
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);
52
52
<span class="returnvalue">gint</span>                <a class="link" href="libedataserver-e-util.html#e-util-utf8-strcasecmp" title="e_util_utf8_strcasecmp ()">e_util_utf8_strcasecmp</a>              (<em class="parameter"><code>const <span class="type">gchar</span> *s1</code></em>,
53
53
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *s2</code></em>);
54
 
<span class="returnvalue">gchar</span> *             <a class="link" href="libedataserver-e-util.html#e-util-utf8-remove-accents" title="e_util_utf8_remove_accents ()">e_util_utf8_remove_accents</a>          (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);
55
 
<span class="returnvalue">gchar</span> *             <a class="link" href="libedataserver-e-util.html#e-util-utf8-make-valid" title="e_util_utf8_make_valid ()">e_util_utf8_make_valid</a>              (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);
 
54
<span class="returnvalue">gchar</span> *                           <a class="link" href="libedataserver-e-util.html#e-util-utf8-remove-accents" title="e_util_utf8_remove_accents ()">e_util_utf8_remove_accents</a>          (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);
 
55
<span class="returnvalue">gchar</span> *                           <a class="link" href="libedataserver-e-util.html#e-util-utf8-make-valid" title="e_util_utf8_make_valid ()">e_util_utf8_make_valid</a>              (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);
56
56
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-util-ensure-gdbus-string" title="e_util_ensure_gdbus_string ()">e_util_ensure_gdbus_string</a>          (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>,
57
57
                                                         <em class="parameter"><code><span class="type">gchar</span> **gdbus_str</code></em>);
58
58
<span class="returnvalue">guint64</span>             <a class="link" href="libedataserver-e-util.html#e-util-gthread-id" title="e_util_gthread_id ()">e_util_gthread_id</a>                   (<em class="parameter"><code><span class="type">GThread</span> *thread</code></em>);
65
65
                                                         <em class="parameter"><code><span class="type">gsize</span> max</code></em>,
66
66
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *fmt</code></em>,
67
67
                                                         <em class="parameter"><code>const <span class="type">struct tm</span> *tm</code></em>);
68
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-util-get-prefix" title="e_util_get_prefix ()">e_util_get_prefix</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
69
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-util-get-cp-prefix" title="e_util_get_cp_prefix ()">e_util_get_cp_prefix</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
70
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-util.html#e-util-get-localedir" title="e_util_get_localedir ()">e_util_get_localedir</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
71
 
<span class="returnvalue">gchar</span> *             <a class="link" href="libedataserver-e-util.html#e-util-replace-prefix" title="e_util_replace_prefix ()">e_util_replace_prefix</a>               (<em class="parameter"><code>const <span class="type">gchar</span> *configure_time_prefix</code></em>,
 
68
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-util-get-prefix" title="e_util_get_prefix ()">e_util_get_prefix</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
 
69
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-util-get-cp-prefix" title="e_util_get_cp_prefix ()">e_util_get_cp_prefix</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
 
70
const <span class="returnvalue">gchar</span> *        <a class="link" href="libedataserver-e-util.html#e-util-get-localedir" title="e_util_get_localedir ()">e_util_get_localedir</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
 
71
<span class="returnvalue">gchar</span> *                           <a class="link" href="libedataserver-e-util.html#e-util-replace-prefix" title="e_util_replace_prefix ()">e_util_replace_prefix</a>               (<em class="parameter"><code>const <span class="type">gchar</span> *configure_time_prefix</code></em>,
72
72
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *runtime_prefix</code></em>,
73
73
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *configure_time_path</code></em>);
74
74
<span class="returnvalue">gint</span>                <a class="link" href="libedataserver-e-util.html#e-data-server-util-get-dbus-call-timeout" title="e_data_server_util_get_dbus_call_timeout ()">e_data_server_util_get_dbus_call_timeout</a>
98
98
<hr>
99
99
<div class="refsect2">
100
100
<a name="e-get-user-cache-dir"></a><h3>e_get_user_cache_dir ()</h3>
101
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_get_user_cache_dir                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
101
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_get_user_cache_dir                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
102
102
<p>
103
103
Returns a base directory in which to store user-specific,
104
104
non-essential cached data for Evolution or Evolution-Data-Server.
119
119
<hr>
120
120
<div class="refsect2">
121
121
<a name="e-get-user-config-dir"></a><h3>e_get_user_config_dir ()</h3>
122
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_get_user_config_dir               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
122
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_get_user_config_dir               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
123
123
<p>
124
124
Returns a base directory in which to store user-specific configuration
125
125
information for Evolution or Evolution-Data-Server.
140
140
<hr>
141
141
<div class="refsect2">
142
142
<a name="e-get-user-data-dir"></a><h3>e_get_user_data_dir ()</h3>
143
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_get_user_data_dir                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
143
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_get_user_data_dir                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
144
144
<p>
145
145
Returns a base directory in which to store user-specific data for
146
146
Evolution or Evolution-Data-Server.
161
161
<hr>
162
162
<div class="refsect2">
163
163
<a name="e-util-strstrcase"></a><h3>e_util_strstrcase ()</h3>
164
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_util_strstrcase                   (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
 
164
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_util_strstrcase                   (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
165
165
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);</pre>
166
166
<p>
167
167
Find the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, ignoring case for
189
189
<hr>
190
190
<div class="refsect2">
191
191
<a name="e-util-unicode-get-utf8"></a><h3>e_util_unicode_get_utf8 ()</h3>
192
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_util_unicode_get_utf8             (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 
192
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_util_unicode_get_utf8             (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
193
193
                                                         <em class="parameter"><code><span class="type">gunichar</span> *out</code></em>);</pre>
194
194
<p>
195
195
Get a UTF-8 character from the beginning of <em class="parameter"><code>text</code></em>.
215
215
<hr>
216
216
<div class="refsect2">
217
217
<a name="e-util-utf8-strstrcase"></a><h3>e_util_utf8_strstrcase ()</h3>
218
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_util_utf8_strstrcase              (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
 
218
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_util_utf8_strstrcase              (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
219
219
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);</pre>
220
220
<p>
221
221
Find the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, ignoring case. (No
236
236
<tr>
237
237
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
238
238
<td>A pointer to the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, or
239
 
<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if no match is found, or if either of the strings are
 
239
<code class="literal">NULL</code> if no match is found, or if either of the strings are
240
240
not legal UTF-8 strings.</td>
241
241
</tr>
242
242
</tbody>
245
245
<hr>
246
246
<div class="refsect2">
247
247
<a name="e-util-utf8-strstrcasedecomp"></a><h3>e_util_utf8_strstrcasedecomp ()</h3>
248
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_util_utf8_strstrcasedecomp        (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
 
248
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_util_utf8_strstrcasedecomp        (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
249
249
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);</pre>
250
250
<p>
251
251
Find the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, where both <em class="parameter"><code>needle</code></em>
266
266
<tr>
267
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
268
268
<td>A pointer to the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, or
269
 
<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if either of the strings are not legal UTF-8 strings.</td>
 
269
<code class="literal">NULL</code> if either of the strings are not legal UTF-8 strings.</td>
270
270
</tr>
271
271
</tbody>
272
272
</table></div>
302
302
<hr>
303
303
<div class="refsect2">
304
304
<a name="e-util-utf8-remove-accents"></a><h3>e_util_utf8_remove_accents ()</h3>
305
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_util_utf8_remove_accents          (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
 
305
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_util_utf8_remove_accents          (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
306
306
<p>
307
307
Returns a newly-allocated copy of <em class="parameter"><code>str</code></em> with accents removed.
308
308
</p>
311
311
<tbody>
312
312
<tr>
313
313
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
314
 
<td>a UTF-8 string, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
314
<td>a UTF-8 string, or <code class="literal">NULL</code>
315
315
</td>
316
316
</tr>
317
317
<tr>
325
325
<hr>
326
326
<div class="refsect2">
327
327
<a name="e-util-utf8-make-valid"></a><h3>e_util_utf8_make_valid ()</h3>
328
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_util_utf8_make_valid              (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
 
328
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_util_utf8_make_valid              (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>);</pre>
329
329
<p>
330
330
Returns a newly-allocated copy of <em class="parameter"><code>str</code></em>, with invalid characters
331
331
replaced by Unicode replacement characters (U+FFFD).
361
361
string pointed to by <em class="parameter"><code>gdbus_str</code></em> with <code class="function">g_free()</code>.
362
362
</p>
363
363
<p>
364
 
If <em class="parameter"><code>str</code></em> is <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the function returns an empty string and does not
 
364
If <em class="parameter"><code>str</code></em> is <code class="literal">NULL</code>, the function returns an empty string and does not
365
365
set <em class="parameter"><code>gdbus_str</code></em>.
366
366
</p>
367
367
<p>
394
394
<tbody>
395
395
<tr>
396
396
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
397
 
<td>a possibly invalid UTF-8 string, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
397
<td>a possibly invalid UTF-8 string, or <code class="literal">NULL</code>
398
398
</td>
399
399
</tr>
400
400
<tr>
527
527
<hr>
528
528
<div class="refsect2">
529
529
<a name="e-util-get-prefix"></a><h3>e_util_get_prefix ()</h3>
530
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_util_get_prefix                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
530
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_util_get_prefix                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
531
531
<p>
532
532
</p>
533
533
</div>
534
534
<hr>
535
535
<div class="refsect2">
536
536
<a name="e-util-get-cp-prefix"></a><h3>e_util_get_cp_prefix ()</h3>
537
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_util_get_cp_prefix                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
537
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_util_get_cp_prefix                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
538
538
<p>
539
539
</p>
540
540
</div>
541
541
<hr>
542
542
<div class="refsect2">
543
543
<a name="e-util-get-localedir"></a><h3>e_util_get_localedir ()</h3>
544
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_util_get_localedir                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
544
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            e_util_get_localedir                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
545
545
<p>
546
546
</p>
547
547
</div>
548
548
<hr>
549
549
<div class="refsect2">
550
550
<a name="e-util-replace-prefix"></a><h3>e_util_replace_prefix ()</h3>
551
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_util_replace_prefix               (<em class="parameter"><code>const <span class="type">gchar</span> *configure_time_prefix</code></em>,
 
551
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       e_util_replace_prefix               (<em class="parameter"><code>const <span class="type">gchar</span> *configure_time_prefix</code></em>,
552
552
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *runtime_prefix</code></em>,
553
553
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *configure_time_path</code></em>);</pre>
554
554
<p>
631
631
</div>
632
632
<div class="footer">
633
633
<hr>
634
 
          Generated by GTK-Doc V1.17.1</div>
 
634
          Generated by GTK-Doc V1.17</div>
635
635
</body>
636
636
</html>
 
 
b'\\ No newline at end of file'