/usr/share/gtk-doc/html/libedataserver/libedataserver-e-util.html is in libedataserver1.2-dev 3.2.3-0ubuntu7.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-util</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="prev" href="libedataserver-e-uid.html" title="e-uid">
<link rel="next" href="libedataserver-e-url.html" title="e-url">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libedataserver-e-uid.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Utilities (libedataserver)</th>
<td><a accesskey="n" href="libedataserver-e-url.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserver-e-util.synopsis" class="shortcut">Top</a>
|
<a href="#libedataserver-e-util.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserver-e-util"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserver-e-util.top_of_page"></a>e-util</span></h2>
<p>e-util</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserver-e-util.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="libedataserver-e-util.html#tm" title="struct tm">tm</a>;
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>);
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>);
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>);
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);
<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>,
<em class="parameter"><code><span class="type">gunichar</span> *out</code></em>);
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>,
<em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);
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>,
<em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *s2</code></em>);
<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>);
<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>);
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>,
<em class="parameter"><code><span class="type">gchar</span> **gdbus_str</code></em>);
<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>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-e-util.html#e-filename-make-safe" title="e_filename_make_safe ()">e_filename_make_safe</a> (<em class="parameter"><code><span class="type">gchar</span> *string</code></em>);
<span class="returnvalue">gsize</span> <a class="link" href="libedataserver-e-util.html#e-utf8-strftime" title="e_utf8_strftime ()">e_utf8_strftime</a> (<em class="parameter"><code><span class="type">gchar</span> *string</code></em>,
<em class="parameter"><code><span class="type">gsize</span> max</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *fmt</code></em>,
<em class="parameter"><code>const <span class="type">struct tm</span> *tm</code></em>);
<span class="returnvalue">gsize</span> <a class="link" href="libedataserver-e-util.html#e-strftime" title="e_strftime ()">e_strftime</a> (<em class="parameter"><code><span class="type">gchar</span> *string</code></em>,
<em class="parameter"><code><span class="type">gsize</span> max</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *fmt</code></em>,
<em class="parameter"><code>const <span class="type">struct tm</span> *tm</code></em>);
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>);
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>);
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>);
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *runtime_prefix</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *configure_time_path</code></em>);
<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>
(<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-e-util.html#e-data-server-util-set-dbus-call-timeout" title="e_data_server_util_set_dbus_call_timeout ()">e_data_server_util_set_dbus_call_timeout</a>
(<em class="parameter"><code><span class="type">gint</span> timeout_msec</code></em>);
#define <a class="link" href="libedataserver-e-util.html#e-pointer-tracker-track" title="e_pointer_tracker_track()">e_pointer_tracker_track</a> (ptr)
<span class="returnvalue">void</span> <a class="link" href="libedataserver-e-util.html#e-pointer-tracker-track-with-info" title="e_pointer_tracker_track_with_info ()">e_pointer_tracker_track_with_info</a> (<em class="parameter"><code><span class="type">gpointer</span> ptr</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *info</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-e-util.html#e-pointer-tracker-untrack" title="e_pointer_tracker_untrack ()">e_pointer_tracker_untrack</a> (<em class="parameter"><code><span class="type">gpointer</span> ptr</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libedataserver-e-util.html#e-pointer-tracker-dump" title="e_pointer_tracker_dump ()">e_pointer_tracker_dump</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserver-e-util.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserver-e-util.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="tm"></a><h3>struct tm</h3>
<pre class="programlisting">struct tm;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-get-user-cache-dir"></a><h3>e_get_user_cache_dir ()</h3>
<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>
<p>
Returns a base directory in which to store user-specific,
non-essential cached data for Evolution or Evolution-Data-Server.
</p>
<p>
The returned string is owned by libedataserver and must not be
modified or freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>base directory for user-specific, non-essential data</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="e-get-user-config-dir"></a><h3>e_get_user_config_dir ()</h3>
<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>
<p>
Returns a base directory in which to store user-specific configuration
information for Evolution or Evolution-Data-Server.
</p>
<p>
The returned string is owned by libedataserver and must not be
modified or freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>base directory for user-specific configuration information</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="e-get-user-data-dir"></a><h3>e_get_user_data_dir ()</h3>
<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>
<p>
Returns a base directory in which to store user-specific data for
Evolution or Evolution-Data-Server.
</p>
<p>
The returned string is owned by libedataserver and must not be
modified or freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>base directory for user-specific data</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="e-util-strstrcase"></a><h3>e_util_strstrcase ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * e_util_strstrcase (<em class="parameter"><code>const <span class="type">gchar</span> *haystack</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);</pre>
<p>
Find the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, ignoring case for
bytes that are ASCII characters.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>haystack</code></em> :</span></p></td>
<td>The string to search in.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>needle</code></em> :</span></p></td>
<td>The string to search for.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A pointer to the start of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, or NULL if
<em class="parameter"><code>needle</code></em> is not found.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-util-unicode-get-utf8"></a><h3>e_util_unicode_get_utf8 ()</h3>
<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>,
<em class="parameter"><code><span class="type">gunichar</span> *out</code></em>);</pre>
<p>
Get a UTF-8 character from the beginning of <em class="parameter"><code>text</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>The string to take the UTF-8 character from.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out</code></em> :</span></p></td>
<td>The location to store the UTF-8 character in.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A pointer to the next character in <em class="parameter"><code>text</code></em> after <em class="parameter"><code>out</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-util-utf8-strstrcase"></a><h3>e_util_utf8_strstrcase ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);</pre>
<p>
Find the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, ignoring case. (No
proper case folding or decomposing is done.) Both <em class="parameter"><code>needle</code></em> and
<em class="parameter"><code>haystack</code></em> are UTF-8 strings.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>haystack</code></em> :</span></p></td>
<td>The string to search in.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>needle</code></em> :</span></p></td>
<td>The string to search for.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A pointer to the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, or
<code class="literal">NULL</code> if no match is found, or if either of the strings are
not legal UTF-8 strings.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-util-utf8-strstrcasedecomp"></a><h3>e_util_utf8_strstrcasedecomp ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *needle</code></em>);</pre>
<p>
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>
and <em class="parameter"><code>haystack</code></em> are UTF-8 strings. Both strings are stripped and
decomposed for comparison, and case is ignored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>haystack</code></em> :</span></p></td>
<td>The string to search in.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>needle</code></em> :</span></p></td>
<td>The string to search for.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A pointer to the first instance of <em class="parameter"><code>needle</code></em> in <em class="parameter"><code>haystack</code></em>, or
<code class="literal">NULL</code> if either of the strings are not legal UTF-8 strings.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-util-utf8-strcasecmp"></a><h3>e_util_utf8_strcasecmp ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> e_util_utf8_strcasecmp (<em class="parameter"><code>const <span class="type">gchar</span> *s1</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *s2</code></em>);</pre>
<p>
Compares two UTF-8 strings using approximate case-insensitive ordering.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>s1</code></em> :</span></p></td>
<td>a UTF-8 string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>s2</code></em> :</span></p></td>
<td>another UTF-8 string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>< 0 if <em class="parameter"><code>s1</code></em> compares before <em class="parameter"><code>s2</code></em>, 0 if they compare equal,
> 0 if <em class="parameter"><code>s1</code></em> compares after <em class="parameter"><code>s2</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-util-utf8-remove-accents"></a><h3>e_util_utf8_remove_accents ()</h3>
<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>
<p>
Returns a newly-allocated copy of <em class="parameter"><code>str</code></em> with accents removed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>a UTF-8 string, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated string</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="e-util-utf8-make-valid"></a><h3>e_util_utf8_make_valid ()</h3>
<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>
<p>
Returns a newly-allocated copy of <em class="parameter"><code>str</code></em>, with invalid characters
replaced by Unicode replacement characters (U+FFFD).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>a UTF-8 string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated string</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="e-util-ensure-gdbus-string"></a><h3>e_util_ensure_gdbus_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * e_util_ensure_gdbus_string (<em class="parameter"><code>const <span class="type">gchar</span> *str</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **gdbus_str</code></em>);</pre>
<p>
If <em class="parameter"><code>str</code></em> is a valid UTF-8 string, the function returns <em class="parameter"><code>str</code></em> and does
not set <em class="parameter"><code>gdbus_str</code></em>.
</p>
<p>
If <em class="parameter"><code>str</code></em> is an invalid UTF-8 string, the function calls
<a class="link" href="libedataserver-e-util.html#e-util-utf8-make-valid" title="e_util_utf8_make_valid ()"><code class="function">e_util_utf8_make_valid()</code></a> and points <em class="parameter"><code>gdbus_str</code></em> to the newly-allocated,
valid UTF-8 string, and also returns it. The caller should free the
string pointed to by <em class="parameter"><code>gdbus_str</code></em> with <code class="function">g_free()</code>.
</p>
<p>
If <em class="parameter"><code>str</code></em> is <code class="literal">NULL</code>, the function returns an empty string and does not
set <em class="parameter"><code>gdbus_str</code></em>.
</p>
<p>
Admittedly, the function semantics are a little awkward. The example
below illustrates the easiest way to cope with the <em class="parameter"><code>gdbus_str</code></em> argument:
</p>
<p>
<informalexample>
<programlisting>
const gchar *trusted_utf8;
gchar *allocated = NULL;
</p>
<p>
trusted_utf8 = e_util_ensure_gdbus_string (untrusted_utf8, &allocated);
</p>
<p>
Do stuff with trusted_utf8, then clear it.
</p>
<p>
trusted_utf8 = NULL;
</p>
<p>
g_free (allocated);
allocated = NULL;
</programlisting>
</informalexample>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>a possibly invalid UTF-8 string, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gdbus_str</code></em> :</span></p></td>
<td>return location for the corrected string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a valid UTF-8 string</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="e-util-gthread-id"></a><h3>e_util_gthread_id ()</h3>
<pre class="programlisting"><span class="returnvalue">guint64</span> e_util_gthread_id (<em class="parameter"><code><span class="type">GThread</span> *thread</code></em>);</pre>
<p>
Returns a 64-bit integer hopefully uniquely identifying the
thread. To be used in debugging output and logging only.
The returned value is just a cast of a pointer to the 64-bit integer.
</p>
<p>
There is no guarantee that calling <a class="link" href="libedataserver-e-util.html#e-util-gthread-id" title="e_util_gthread_id ()"><code class="function">e_util_gthread_id()</code></a> on one
thread first and later after that thread has dies on another won't
return the same integer.
</p>
<p>
On Linux and Win32, known to really return a unique id for each
thread existing at a certain time. No guarantee that ids won't be
reused after a thread has terminated, though.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>thread</code></em> :</span></p></td>
<td>A <span class="type">GThread</span> pointer</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A 64-bit integer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="e-filename-make-safe"></a><h3>e_filename_make_safe ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_filename_make_safe (<em class="parameter"><code><span class="type">gchar</span> *string</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-utf8-strftime"></a><h3>e_utf8_strftime ()</h3>
<pre class="programlisting"><span class="returnvalue">gsize</span> e_utf8_strftime (<em class="parameter"><code><span class="type">gchar</span> *string</code></em>,
<em class="parameter"><code><span class="type">gsize</span> max</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *fmt</code></em>,
<em class="parameter"><code>const <span class="type">struct tm</span> *tm</code></em>);</pre>
<p>
The UTF-8 equivalent of <a class="link" href="libedataserver-e-util.html#e-strftime" title="e_strftime ()"><code class="function">e_strftime()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>The string array to store the result in.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>The size of array <em class="parameter"><code>s</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td>
<td>The formatting to use on <em class="parameter"><code>tm</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tm</code></em> :</span></p></td>
<td>The time value to format.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of characters placed in <em class="parameter"><code>s</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-strftime"></a><h3>e_strftime ()</h3>
<pre class="programlisting"><span class="returnvalue">gsize</span> e_strftime (<em class="parameter"><code><span class="type">gchar</span> *string</code></em>,
<em class="parameter"><code><span class="type">gsize</span> max</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *fmt</code></em>,
<em class="parameter"><code>const <span class="type">struct tm</span> *tm</code></em>);</pre>
<p>
This function is a wrapper around the strftime (3) function, which
converts the &percnt;l and &percnt;k (12h and 24h) format variables
if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>The string array to store the result in.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>The size of array <em class="parameter"><code>s</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fmt</code></em> :</span></p></td>
<td>The formatting to use on <em class="parameter"><code>tm</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tm</code></em> :</span></p></td>
<td>The time value to format.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The number of characters placed in <em class="parameter"><code>s</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-util-get-prefix"></a><h3>e_util_get_prefix ()</h3>
<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>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-util-get-cp-prefix"></a><h3>e_util_get_cp_prefix ()</h3>
<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>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-util-get-localedir"></a><h3>e_util_get_localedir ()</h3>
<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>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-util-replace-prefix"></a><h3>e_util_replace_prefix ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *runtime_prefix</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *configure_time_path</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-data-server-util-get-dbus-call-timeout"></a><h3>e_data_server_util_get_dbus_call_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> e_data_server_util_get_dbus_call_timeout
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns the value set by <a class="link" href="libedataserver-e-util.html#e-data-server-util-set-dbus-call-timeout" title="e_data_server_util_set_dbus_call_timeout ()"><code class="function">e_data_server_util_set_dbus_call_timeout()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the D-Bus call timeout in milliseconds</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="e-data-server-util-set-dbus-call-timeout"></a><h3>e_data_server_util_set_dbus_call_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_data_server_util_set_dbus_call_timeout
(<em class="parameter"><code><span class="type">gint</span> timeout_msec</code></em>);</pre>
<p>
Sets default timeout, in milliseconds, for calls of <code class="function">g_dbus_proxy_call()</code>
family functions.
</p>
<p>
-1 means the default value as set by D-Bus itself.
G_MAXINT means no timeout at all.
</p>
<p>
Default value is set also by configure option --with-dbus-call-timeout=ms
and -1 is used when not set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>timeout_msec</code></em> :</span></p></td>
<td>default timeout for D-Bus calls in miliseconds</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0</p>
</div>
<hr>
<div class="refsect2">
<a name="e-pointer-tracker-track"></a><h3>e_pointer_tracker_track()</h3>
<pre class="programlisting">#define e_pointer_tracker_track(ptr)</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-pointer-tracker-track-with-info"></a><h3>e_pointer_tracker_track_with_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_pointer_tracker_track_with_info (<em class="parameter"><code><span class="type">gpointer</span> ptr</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *info</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-pointer-tracker-untrack"></a><h3>e_pointer_tracker_untrack ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_pointer_tracker_untrack (<em class="parameter"><code><span class="type">gpointer</span> ptr</code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="e-pointer-tracker-dump"></a><h3>e_pointer_tracker_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_pointer_tracker_dump (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
FIXME: Document me.
</p>
<p class="since">Since 3.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|