/usr/share/gtk-doc/html/librdf/redland-hash.html is in librdf0-dev 1.0.17-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Hashes</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Redland RDF Library Manual">
<link rel="up" href="reference-manual.html" title="Part II. Reference Manual">
<link rel="prev" href="redland-files.html" title="Files">
<link rel="next" href="redland-heuristics.html" title="Heuristics">
<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="redland-files.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="reference-manual.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">Redland RDF Library Manual</th>
<td><a accesskey="n" href="redland-heuristics.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#redland-hash.synopsis" class="shortcut">Top</a>
|
<a href="#redland-hash.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="redland-hash"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="redland-hash.top_of_page"></a>Hashes</span></h2>
<p>Hashes — Key:Value hashes or dictionaries.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="redland-hash.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">typedef <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash">librdf_hash</a>;
typedef <a class="link" href="redland-hash.html#librdf-hash-cursor" title="librdf_hash_cursor">librdf_hash_cursor</a>;
<a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * <a class="link" href="redland-hash.html#librdf-new-hash" title="librdf_new_hash ()">librdf_new_hash</a> (<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * <a class="link" href="redland-hash.html#librdf-new-hash-from-string" title="librdf_new_hash_from_string ()">librdf_new_hash_from_string</a> (<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *string</code></em>);
<a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * <a class="link" href="redland-hash.html#librdf-new-hash-from-array-of-strings" title="librdf_new_hash_from_array_of_strings ()">librdf_new_hash_from_array_of_strings</a>
(<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> **array</code></em>);
<a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * <a class="link" href="redland-hash.html#librdf-new-hash-from-hash" title="librdf_new_hash_from_hash ()">librdf_new_hash_from_hash</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *old_hash</code></em>);
<span class="returnvalue">void</span> <a class="link" href="redland-hash.html#librdf-free-hash" title="librdf_free_hash ()">librdf_free_hash</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="redland-hash.html#librdf-hash-get" title="librdf_hash_get ()">librdf_hash_get</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);
<span class="returnvalue">int</span> <a class="link" href="redland-hash.html#librdf-hash-get-as-boolean" title="librdf_hash_get_as_boolean ()">librdf_hash_get_as_boolean</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);
<span class="returnvalue">long</span> <a class="link" href="redland-hash.html#librdf-hash-get-as-long" title="librdf_hash_get_as_long ()">librdf_hash_get_as_long</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="redland-hash.html#librdf-hash-get-del" title="librdf_hash_get_del ()">librdf_hash_get_del</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);
<span class="returnvalue">int</span> <a class="link" href="redland-hash.html#librdf-hash-put-strings" title="librdf_hash_put_strings ()">librdf_hash_put_strings</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="redland-hash.html#librdf-hash-print" title="librdf_hash_print ()">librdf_hash_print</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);
<span class="returnvalue">void</span> <a class="link" href="redland-hash.html#librdf-hash-print-keys" title="librdf_hash_print_keys ()">librdf_hash_print_keys</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);
<span class="returnvalue">void</span> <a class="link" href="redland-hash.html#librdf-hash-print-values" title="librdf_hash_print_values ()">librdf_hash_print_values</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key_string</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);
unsigned <span class="returnvalue">char</span> * <a class="link" href="redland-hash.html#librdf-hash-interpret-template" title="librdf_hash_interpret_template ()">librdf_hash_interpret_template</a> (<em class="parameter"><code>const unsigned <span class="type">char</span> *template_string</code></em>,
<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *dictionary</code></em>,
<em class="parameter"><code>const unsigned <span class="type">char</span> *prefix</code></em>,
<em class="parameter"><code>const unsigned <span class="type">char</span> *suffix</code></em>);
<span class="returnvalue">int</span> <a class="link" href="redland-hash.html#librdf-hash-from-string" title="librdf_hash_from_string ()">librdf_hash_from_string</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *string</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="redland-hash.html#librdf-hash-to-string" title="librdf_hash_to_string ()">librdf_hash_to_string</a> (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filter[]</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="redland-hash.description"></a><h2>Description</h2>
<p>
Interface to implementations of key:value hashes either in memory, on
disk and with persistence. Keys may have multiple and duplicate values.
</p>
</div>
<div class="refsect1">
<a name="redland-hash.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="librdf-hash"></a><h3>librdf_hash</h3>
<pre class="programlisting">typedef struct librdf_hash_s librdf_hash;
</pre>
<p>
Redland hash class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-cursor"></a><h3>librdf_hash_cursor</h3>
<pre class="programlisting">typedef struct librdf_hash_cursor_s librdf_hash_cursor;
</pre>
<p>
Redland hash cursor class.
</p>
</div>
<hr>
<div class="refsect2">
<a name="librdf-new-hash"></a><h3>librdf_new_hash ()</h3>
<pre class="programlisting"><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * librdf_new_hash (<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Constructor - create a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td>
<td>redland world object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>factory name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-new-hash-from-string"></a><h3>librdf_new_hash_from_string ()</h3>
<pre class="programlisting"><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * librdf_new_hash_from_string (<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *string</code></em>);</pre>
<p>
Constructor - create a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object from a string.
</p>
<p>
See <a class="link" href="redland-hash.html#librdf-hash-from-string" title="librdf_hash_from_string ()"><span class="type">librdf_hash_from_string</span></a> for the string format.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td>
<td>redland world object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>hash name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>hash encoded as a string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-new-hash-from-array-of-strings"></a><h3>librdf_new_hash_from_array_of_strings ()</h3>
<pre class="programlisting"><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * librdf_new_hash_from_array_of_strings
(<em class="parameter"><code><a class="link" href="redland-world.html#librdf-world" title="librdf_world"><span class="type">librdf_world</span></a> *world</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> **array</code></em>);</pre>
<p>
Constructor - create a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object from an array of strings.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>world</code></em> :</span></p></td>
<td>redland world object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>hash name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td>address of the start of the array of char* pointers</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-new-hash-from-hash"></a><h3>librdf_new_hash_from_hash ()</h3>
<pre class="programlisting"><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="returnvalue">librdf_hash</span></a> * librdf_new_hash_from_hash (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *old_hash</code></em>);</pre>
<p>
Copy Constructor - create a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object from an existing one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>old_hash</code></em> :</span></p></td>
<td>the hash to use to construct the hash</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-free-hash"></a><h3>librdf_free_hash ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> librdf_free_hash (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>);</pre>
<p>
Destructor - destroy a <a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>hash object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-get"></a><h3>librdf_hash_get ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * librdf_hash_get (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
Retrieve one value from hash for a given key as string.
</p>
<p>
The value returned is from newly allocated memory which the
caller must free.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>hash object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>pointer to key</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-get-as-boolean"></a><h3>librdf_hash_get_as_boolean ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> librdf_hash_get_as_boolean (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
Lookup a hash key and decode value as a boolean.
</p>
<p>
False values: "no", "false"
True values: "yes", "true"
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>
<a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>key string to look up</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>>0 (for true), 0 (for false) or <0 (for key not found or not known boolean value)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-get-as-long"></a><h3>librdf_hash_get_as_long ()</h3>
<pre class="programlisting"><span class="returnvalue">long</span> librdf_hash_get_as_long (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
Lookup a hash key and decode value as a long.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>
<a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>key string to look up</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>>0 (for success), <0 (for key not found or not known boolean value)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-get-del"></a><h3>librdf_hash_get_del ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * librdf_hash_get_del (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>);</pre>
<p>
Retrieve one value from hash for a given key as string and remove all values with that key.
</p>
<p>
The value returned is from newly allocated memory which the
caller must free.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>hash object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>pointer to key</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-put-strings"></a><h3>librdf_hash_put_strings ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> librdf_hash_put_strings (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
<p>
Insert key/value pairs into the hash as strings.
</p>
<p>
The key and values are copied into the hash, no sharing i s done.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>hash object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>value</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non 0 on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-print"></a><h3>librdf_hash_print ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> librdf_hash_print (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);</pre>
<p>
Pretty print the hash to a file descriptor.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>the hash</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fh</code></em> :</span></p></td>
<td>file handle</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-print-keys"></a><h3>librdf_hash_print_keys ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> librdf_hash_print_keys (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);</pre>
<p>
Pretty print the keys to a file descriptor.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>the hash</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fh</code></em> :</span></p></td>
<td>file handle</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-print-values"></a><h3>librdf_hash_print_values ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> librdf_hash_print_values (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key_string</code></em>,
<em class="parameter"><code><span class="type">FILE</span> *fh</code></em>);</pre>
<p>
Pretty print the values of one key to a file descriptor.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>the hash</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_string</code></em> :</span></p></td>
<td>the key as a string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fh</code></em> :</span></p></td>
<td>file handle</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-interpret-template"></a><h3>librdf_hash_interpret_template ()</h3>
<pre class="programlisting">unsigned <span class="returnvalue">char</span> * librdf_hash_interpret_template (<em class="parameter"><code>const unsigned <span class="type">char</span> *template_string</code></em>,
<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *dictionary</code></em>,
<em class="parameter"><code>const unsigned <span class="type">char</span> *prefix</code></em>,
<em class="parameter"><code>const unsigned <span class="type">char</span> *suffix</code></em>);</pre>
<p>
Interpret keys in a template string to their value in a dictionary.
</p>
<p>
Can be used to do variable substitution for a string where
the syntax that marks the variable is defined by the <em class="parameter"><code>prefix</code></em>
and <em class="parameter"><code>suffix</code></em> strings, and the variables are stored in the <em class="parameter"><code>dictionary</code></em>
hash table.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>template_string</code></em> :</span></p></td>
<td>template string to interprate</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dictionary</code></em> :</span></p></td>
<td>dictionary of key/values to substitute</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
<td>prefix to mark a key in the template</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>suffix</code></em> :</span></p></td>
<td>suffix to mark a key in the template</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Newly allocated string, or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-from-string"></a><h3>librdf_hash_from_string ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> librdf_hash_from_string (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *string</code></em>);</pre>
<p>
Initialise a hash from a string.
</p>
<p>
The string format is something like:
key1='value1',key2='value2', key3='\'quoted value\''
</p>
<p>
The 's are required and whitespace can appear around the = and ,s
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>hash object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>hash encoded as a string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non 0 on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="librdf-hash-to-string"></a><h3>librdf_hash_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * librdf_hash_to_string (<em class="parameter"><code><a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> *hash</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *filter[]</code></em>);</pre>
<p>
Format the hash as a string, suitable for parsing by librdf_hash_from_string.
</p>
<p>
Note: this method allocates a new string since this is a _to_ method
and the caller must call <a class="link" href="redland-general.html#librdf-free-memory" title="librdf_free_memory ()"><code class="function">librdf_free_memory()</code></a> to free the resulting memory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash</code></em> :</span></p></td>
<td>
<a class="link" href="redland-hash.html#librdf-hash" title="librdf_hash"><span class="type">librdf_hash</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>NULL terminated list of keys to ignore</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>string representation of the hash or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|