/usr/share/gtk-doc/html/libebackend/EFileCache.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution-Data-Server Manual: Backend Utilities (libebackend): EFileCache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch03.html" title="Miscellaneous Utilities">
<link rel="prev" href="ch03.html" title="Miscellaneous Utilities">
<link rel="next" href="libebackend-e-db3-utils.html" title="e-db3-utils">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#EFileCache.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#EFileCache.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#EFileCache.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libebackend-e-db3-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EFileCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EFileCache.top_of_page"></a>EFileCache</span></h2>
<p>EFileCache — Simple file-based hash table for strings</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EFileCache.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="EFileCache.html" title="EFileCache"><span class="returnvalue">EFileCache</span></a> *
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-new" title="e_file_cache_new ()">e_file_cache_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-remove" title="e_file_cache_remove ()">e_file_cache_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-clean" title="e_file_cache_clean ()">e_file_cache_clean</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-get-object" title="e_file_cache_get_object ()">e_file_cache_get_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-get-objects" title="e_file_cache_get_objects ()">e_file_cache_get_objects</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-get-keys" title="e_file_cache_get_keys ()">e_file_cache_get_keys</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-add-object" title="e_file_cache_add_object ()">e_file_cache_add_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-replace-object" title="e_file_cache_replace_object ()">e_file_cache_replace_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-remove-object" title="e_file_cache_remove_object ()">e_file_cache_remove_object</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-freeze-changes" title="e_file_cache_freeze_changes ()">e_file_cache_freeze_changes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-thaw-changes" title="e_file_cache_thaw_changes ()">e_file_cache_thaw_changes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="EFileCache.html#e-file-cache-get-filename" title="e_file_cache_get_filename ()">e_file_cache_get_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EFileCache.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="EFileCache.html#EFileCache--filename" title="The “filename” property">filename</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EFileCache.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EFileCache.html#EFileCache-struct" title="struct EFileCache">EFileCache</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EFileCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> EFileCache
</pre>
</div>
<div class="refsect1">
<a name="EFileCache.description"></a><h2>Description</h2>
<p>An <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> is a simple hash table of strings backed by an XML file
for permanent storage. The XML file is written to disk with every unless
the cache is temporarily frozen with <a class="link" href="EFileCache.html#e-file-cache-freeze-changes" title="e_file_cache_freeze_changes ()"><code class="function">e_file_cache_freeze_changes()</code></a>.</p>
</div>
<div class="refsect1">
<a name="EFileCache.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-file-cache-new"></a><h3>e_file_cache_new ()</h3>
<pre class="programlisting"><a class="link" href="EFileCache.html" title="EFileCache"><span class="returnvalue">EFileCache</span></a> *
e_file_cache_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>Creates a new <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> object, which implements a cache of
objects. Useful for remote backends.</p>
<div class="refsect3">
<a name="id-1.4.2.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>filename where the cache is kept</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.2.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-remove"></a><h3>e_file_cache_remove ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_file_cache_remove (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
<p>Remove the cache from disk.</p>
<div class="refsect3">
<a name="id-1.4.2.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.3.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if a file error occurred</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-clean"></a><h3>e_file_cache_clean ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_file_cache_clean (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
<p>Clean up the cache's contents.</p>
<div class="refsect3">
<a name="id-1.4.2.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.4.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> always</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-get-object"></a><h3>e_file_cache_get_object ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_file_cache_get_object (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>Returns the object corresponding to <em class="parameter"><code>key</code></em>
. If no such object exists
in <em class="parameter"><code>cache</code></em>
, the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the hash key of the object to find</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.5.6"></a><h4>Returns</h4>
<p> the object corresponding to <em class="parameter"><code>key</code></em>
</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-get-objects"></a><h3>e_file_cache_get_objects ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
e_file_cache_get_objects (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
<p>Returns a list of objects in <em class="parameter"><code>cache</code></em>
. The objects are owned by <em class="parameter"><code>cache</code></em>
and
must not be modified or freed. Free the returned list with <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.6.6"></a><h4>Returns</h4>
<p> a list of objects</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-get-keys"></a><h3>e_file_cache_get_keys ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
e_file_cache_get_keys (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
<p>Returns a list of keys in <em class="parameter"><code>cache</code></em>
. The keys are owned by <em class="parameter"><code>cache</code></em>
and must
not be modified or freed. Free the returned list with <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.7.6"></a><h4>Returns</h4>
<p> a list of keys</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-add-object"></a><h3>e_file_cache_add_object ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_file_cache_add_object (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>Adds a new <em class="parameter"><code>key</code></em>
/ <em class="parameter"><code>value</code></em>
entry to <em class="parameter"><code>cache</code></em>
. If an object corresponding
to <em class="parameter"><code>key</code></em>
already exists in <em class="parameter"><code>cache</code></em>
, the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the hash key of the object to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the object to add</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.8.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>key</code></em>
already exists</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-replace-object"></a><h3>e_file_cache_replace_object ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_file_cache_replace_object (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_value</code></em>);</pre>
<p>Replaces the object corresponding to <em class="parameter"><code>key</code></em>
with <em class="parameter"><code>new_value</code></em>
.
If no such object exists in <em class="parameter"><code>cache</code></em>
, the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the hash key of the object to replace</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_value</p></td>
<td class="parameter_description"><p>the new object for <em class="parameter"><code>key</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.9.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>key</code></em>
was not found</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-remove-object"></a><h3>e_file_cache_remove_object ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_file_cache_remove_object (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>Removes the object corresponding to <em class="parameter"><code>key</code></em>
from <em class="parameter"><code>cache</code></em>
.
If no such object exists in <em class="parameter"><code>cache</code></em>
, the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the hash key of the object to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.10.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>key</code></em>
was not found</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-freeze-changes"></a><h3>e_file_cache_freeze_changes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_file_cache_freeze_changes (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
<p>Disables temporarily all writes to disk for <em class="parameter"><code>cache</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.2.8.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-thaw-changes"></a><h3>e_file_cache_thaw_changes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_file_cache_thaw_changes (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
<p>Reverts the affects of <a class="link" href="EFileCache.html#e-file-cache-freeze-changes" title="e_file_cache_freeze_changes ()"><code class="function">e_file_cache_freeze_changes()</code></a>.
Each change to <em class="parameter"><code>cache</code></em>
is once again written to disk.</p>
<div class="refsect3">
<a name="id-1.4.2.8.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>an <a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-file-cache-get-filename"></a><h3>e_file_cache_get_filename ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_file_cache_get_filename (<em class="parameter"><code><a class="link" href="EFileCache.html" title="EFileCache"><span class="type">EFileCache</span></a> *cache</code></em>);</pre>
<p>Gets the name of the file where the cache is being stored.</p>
<div class="refsect3">
<a name="id-1.4.2.8.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>A <a class="link" href="EFileCache.html" title="EFileCache"><code class="literal">EFileCache</code></a> object.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.13.6"></a><h4>Returns</h4>
<p> The name of the cache.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="EFileCache.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EFileCache-struct"></a><h3>struct EFileCache</h3>
<pre class="programlisting">struct EFileCache;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
</div>
</div>
<div class="refsect1">
<a name="EFileCache.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EFileCache--filename"></a><h3>The <code class="literal">“filename”</code> property</h3>
<pre class="programlisting"> “filename” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The filename of the cache.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: ""</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|