/usr/share/gtk-doc/html/camel/CamelKeyFile.html is in libcamel1.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelKeyFile</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Storage.html" title="Metadata Storage">
<link rel="prev" href="Storage.html" title="Metadata Storage">
<link rel="next" href="CamelCertDB.html" title="CamelCertDB">
<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="Storage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Storage.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">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelCertDB.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelKeyFile.synopsis" class="shortcut">Top</a>
|
<a href="#CamelKeyFile.description" class="shortcut">Description</a>
|
<a href="#CamelKeyFile.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelKeyFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelKeyFile.top_of_page"></a>CamelKeyFile</span></h2>
<p>CamelKeyFile</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelKeyFile.synopsis"></a><h2>Synopsis</h2>
<a name="CamelBlockFile"></a><pre class="synopsis">typedef <a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t">camel_block_t</a>;
typedef <a class="link" href="CamelKeyFile.html#camel-key-t" title="camel_key_t">camel_key_t</a>;
enum <a class="link" href="CamelKeyFile.html#CamelBlockFileFlags" title="enum CamelBlockFileFlags">CamelBlockFileFlags</a>;
enum <a class="link" href="CamelKeyFile.html#CamelBlockFlags" title="enum CamelBlockFlags">CamelBlockFlags</a>;
struct <a class="link" href="CamelKeyFile.html#CamelBlockRoot" title="struct CamelBlockRoot">CamelBlockRoot</a>;
struct <a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock">CamelBlock</a>;
struct <a class="link" href="CamelKeyFile.html#CamelBlockFile-struct" title="struct CamelBlockFile">CamelBlockFile</a>;
#define <a class="link" href="CamelKeyFile.html#CAMEL-BLOCK-SIZE:CAPS" title="CAMEL_BLOCK_SIZE">CAMEL_BLOCK_SIZE</a>
#define <a class="link" href="CamelKeyFile.html#CAMEL-BLOCK-SIZE-BITS:CAPS" title="CAMEL_BLOCK_SIZE_BITS">CAMEL_BLOCK_SIZE_BITS</a>
<a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="returnvalue">CamelBlockFile</span></a> * <a class="link" href="CamelKeyFile.html#camel-block-file-new" title="camel_block_file_new ()">camel_block_file_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> version[8]</code></em>,
<em class="parameter"><code><span class="type">gsize</span> block_size</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-block-file-rename" title="camel_block_file_rename ()">camel_block_file_rename</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-block-file-delete" title="camel_block_file_delete ()">camel_block_file_delete</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *kf</code></em>);
<a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="returnvalue">CamelBlock</span></a> * <a class="link" href="CamelKeyFile.html#camel-block-file-new-block" title="camel_block_file_new_block ()">camel_block_file_new_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-block-file-free-block" title="camel_block_file_free_block ()">camel_block_file_free_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> id</code></em>);
<a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="returnvalue">CamelBlock</span></a> * <a class="link" href="CamelKeyFile.html#camel-block-file-get-block" title="camel_block_file_get_block ()">camel_block_file_get_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelKeyFile.html#camel-block-file-detach-block" title="camel_block_file_detach_block ()">camel_block_file_detach_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelKeyFile.html#camel-block-file-attach-block" title="camel_block_file_attach_block ()">camel_block_file_attach_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelKeyFile.html#camel-block-file-touch-block" title="camel_block_file_touch_block ()">camel_block_file_touch_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelKeyFile.html#camel-block-file-unref-block" title="camel_block_file_unref_block ()">camel_block_file_unref_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-block-file-sync-block" title="camel_block_file_sync_block ()">camel_block_file_sync_block</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-block-file-sync" title="camel_block_file_sync ()">camel_block_file_sync</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>);
struct <a class="link" href="CamelKeyFile.html#CamelKeyFile-struct" title="struct CamelKeyFile">CamelKeyFile</a>;
<a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="returnvalue">CamelKeyFile</span></a> * <a class="link" href="CamelKeyFile.html#camel-key-file-new" title="camel_key_file_new ()">camel_key_file_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> version[8]</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-key-file-rename" title="camel_key_file_rename ()">camel_key_file_rename</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-key-file-delete" title="camel_key_file_delete ()">camel_key_file_delete</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-key-file-write" title="camel_key_file_write ()">camel_key_file_write</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> *parent</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-key-t" title="camel_key_t"><span class="type">camel_key_t</span></a> *records</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelKeyFile.html#camel-key-file-read" title="camel_key_file_read ()">camel_key_file_read</a> (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> *start</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *len</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-key-t" title="camel_key_t"><span class="type">camel_key_t</span></a> **records</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelKeyFile.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelBlockFile
</pre>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelKeyFile
</pre>
</div>
<div class="refsect1">
<a name="CamelKeyFile.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelKeyFile.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="camel-block-t"></a><h3>camel_block_t</h3>
<pre class="programlisting">typedef guint32 camel_block_t; /* block offset, absolute, bottom BLOCK_SIZE_BITS always 0 */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-key-t"></a><h3>camel_key_t</h3>
<pre class="programlisting">typedef guint32 camel_key_t; /* this is a bitfield of (block offset:BLOCK_SIZE_BITS) */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelBlockFileFlags"></a><h3>enum CamelBlockFileFlags</h3>
<pre class="programlisting">typedef enum {
CAMEL_BLOCK_FILE_SYNC = 1 << 0
} CamelBlockFileFlags;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelBlockFlags"></a><h3>enum CamelBlockFlags</h3>
<pre class="programlisting">typedef enum {
CAMEL_BLOCK_DIRTY = 1 << 0,
CAMEL_BLOCK_DETACHED = 1 << 1
} CamelBlockFlags;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelBlockRoot"></a><h3>struct CamelBlockRoot</h3>
<pre class="programlisting">struct CamelBlockRoot {
gchar version[8]; /* version number */
guint32 flags; /* flags for file */
guint32 block_size; /* block size of this file */
camel_block_t free; /* free block list */
camel_block_t last; /* pointer to end of blocks */
/* subclasses tack on, but no more than CAMEL_BLOCK_SIZE! */
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelBlock"></a><h3>struct CamelBlock</h3>
<pre class="programlisting">struct CamelBlock {
struct _CamelBlock *next;
struct _CamelBlock *prev;
camel_block_t id;
CamelBlockFlags flags;
guint32 refcount;
guint32 align00;
guchar data[CAMEL_BLOCK_SIZE];
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelBlockFile-struct"></a><h3>struct CamelBlockFile</h3>
<pre class="programlisting">struct CamelBlockFile;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-BLOCK-SIZE:CAPS"></a><h3>CAMEL_BLOCK_SIZE</h3>
<pre class="programlisting">#define CAMEL_BLOCK_SIZE (1024)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-BLOCK-SIZE-BITS:CAPS"></a><h3>CAMEL_BLOCK_SIZE_BITS</h3>
<pre class="programlisting">#define CAMEL_BLOCK_SIZE_BITS (10) /* # bits to contain block_size bytes */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-new"></a><h3>camel_block_file_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="returnvalue">CamelBlockFile</span></a> * camel_block_file_new (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> version[8]</code></em>,
<em class="parameter"><code><span class="type">gsize</span> block_size</code></em>);</pre>
<p>
Allocate a new block file, stored at <em class="parameter"><code>path</code></em>. <em class="parameter"><code>version</code></em> contains an 8 character
version string which must match the head of the file, or the file will be
intitialised.
</p>
<p>
<em class="parameter"><code>block_size</code></em> is currently ignored and is set to CAMEL_BLOCK_SIZE.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>@:</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The new block file, or NULL if it could not be created.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-rename"></a><h3>camel_block_file_rename ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_block_file_rename (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-delete"></a><h3>camel_block_file_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_block_file_delete (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *kf</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-new-block"></a><h3>camel_block_file_new_block ()</h3>
<pre class="programlisting"><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="returnvalue">CamelBlock</span></a> * camel_block_file_new_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>);</pre>
<p>
Allocate a new block, return a pointer to it. Old blocks
may be flushed to disk during this call.
</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 block, or NULL if an error occured.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-free-block"></a><h3>camel_block_file_free_block ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_block_file_free_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> id</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-get-block"></a><h3>camel_block_file_get_block ()</h3>
<pre class="programlisting"><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="returnvalue">CamelBlock</span></a> * camel_block_file_get_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> id</code></em>);</pre>
<p>
Retreive a block <em class="parameter"><code>id</code></em>.
</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 block, or NULL if blockid is invalid or a file error
occured.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-detach-block"></a><h3>camel_block_file_detach_block ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_block_file_detach_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);</pre>
<p>
Detatch a block from the block file's cache. The block should
be unref'd or attached when finished with. The block file will
perform no writes of this block or flushing of it if the cache
fills.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-attach-block"></a><h3>camel_block_file_attach_block ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_block_file_attach_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);</pre>
<p>
Reattach a block that has been detached.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-touch-block"></a><h3>camel_block_file_touch_block ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_block_file_touch_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);</pre>
<p>
Mark a block as dirty. The block will be written to disk if
it ever expires from the cache.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-unref-block"></a><h3>camel_block_file_unref_block ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_block_file_unref_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);</pre>
<p>
Mark a block as unused. If a block is used it will not be
written to disk, or flushed from memory.
</p>
<p>
If a block is detatched and this is the last reference, the
block will be freed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-sync-block"></a><h3>camel_block_file_sync_block ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_block_file_sync_block (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlock" title="struct CamelBlock"><span class="type">CamelBlock</span></a> *bl</code></em>);</pre>
<p>
Flush a block to disk immediately. The block will only
be flushed to disk if it is marked as dirty (touched).
</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>-1 on io error.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-block-file-sync"></a><h3>camel_block_file_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_block_file_sync (<em class="parameter"><code><a class="link" href="CamelKeyFile.html#CamelBlockFile"><span class="type">CamelBlockFile</span></a> *bs</code></em>);</pre>
<p>
Sync all dirty blocks to disk, including the root block.
</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>-1 on io error.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="CamelKeyFile-struct"></a><h3>struct CamelKeyFile</h3>
<pre class="programlisting">struct CamelKeyFile;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-key-file-new"></a><h3>camel_key_file_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="returnvalue">CamelKeyFile</span></a> * camel_key_file_new (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> flags</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> version[8]</code></em>);</pre>
<p>
Create a new key file. A linked list of record blocks.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>open flags</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
<td>Version string (header) of file. Currently
written but not checked.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new key file, or NULL if the file could not
be opened/created/initialised.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-key-file-rename"></a><h3>camel_key_file_rename ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_key_file_rename (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-key-file-delete"></a><h3>camel_key_file_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_key_file_delete (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-key-file-write"></a><h3>camel_key_file_write ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_key_file_write (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> *parent</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-key-t" title="camel_key_t"><span class="type">camel_key_t</span></a> *records</code></em>);</pre>
<p>
Write a new list of records to the key file.
</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>-1 on io error. The key file will remain unchanged.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-key-file-read"></a><h3>camel_key_file_read ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_key_file_read (<em class="parameter"><code><a class="link" href="CamelKeyFile.html" title="CamelKeyFile"><span class="type">CamelKeyFile</span></a> *kf</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-block-t" title="camel_block_t"><span class="type">camel_block_t</span></a> *start</code></em>,
<em class="parameter"><code><span class="type">gsize</span> *len</code></em>,
<em class="parameter"><code><a class="link" href="CamelKeyFile.html#camel-key-t" title="camel_key_t"><span class="type">camel_key_t</span></a> **records</code></em>);</pre>
<p>
Read the next block of data from the key file. Returns the number of
records.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
<td>The record pointer. This will be set to the next record pointer on success.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>Number of records read, if != NULL.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>records</code></em> :</span></p></td>
<td>Records, allocated, must be freed with g_free, if != NULL.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on io error.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|