docs/html/gsignond-GSignondDictionary.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsignond API Reference Manual: GSignondDictionary</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch04.html" title="GSignond API for writing GLib-based authentication plugins">
   9 <link rel="prev" href="GSignondPlugin.html" title="GSignondPlugin">
  10 <link rel="next" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#gsignond-GSignondDictionary.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#gsignond-GSignondDictionary.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="GSignondPlugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gsignond-GSignondSessionData.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="gsignond-GSignondDictionary"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="gsignond-GSignondDictionary.top_of_page"></a>GSignondDictionary</span></h2>
  31 <p>GSignondDictionary — a dictionary container holding string keys and variant values</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="gsignond-GSignondDictionary.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <span class="returnvalue">GSignondDictionary</span> *
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new" title="gsignond_dictionary_new ()">gsignond_dictionary_new</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <span class="returnvalue">GSignondDictionary</span> *
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-ref" title="gsignond_dictionary_ref ()">gsignond_dictionary_ref</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <span class="returnvalue">void</span>
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-unref" title="gsignond_dictionary_unref ()">gsignond_dictionary_unref</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <span class="returnvalue">GSignondDictionary</span> *
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-copy" title="gsignond_dictionary_copy ()">gsignond_dictionary_copy</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <span class="returnvalue">GSignondDictionary</span> *
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new-from-variant" title="gsignond_dictionary_new_from_variant ()">gsignond_dictionary_new_from_variant</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 <tr>
  84 <td class="function_type">
  85 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
  86 </td>
  87 <td class="function_name">
  88 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-to-variant" title="gsignond_dictionary_to_variant ()">gsignond_dictionary_to_variant</a> <span class="c_punctuation">()</span>
  89 </td>
  90 </tr>
  91 <tr>
  92 <td class="function_type">
  93 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="returnvalue">GVariantBuilder</span></a> *
  94 </td>
  95 <td class="function_name">
  96 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-to-variant-builder" title="gsignond_dictionary_to_variant_builder ()">gsignond_dictionary_to_variant_builder</a> <span class="c_punctuation">()</span>
  97 </td>
  98 </tr>
  99 <tr>
 100 <td class="function_type">
 101 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 102 </td>
 103 <td class="function_name">
 104 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get" title="gsignond_dictionary_get ()">gsignond_dictionary_get</a> <span class="c_punctuation">()</span>
 105 </td>
 106 </tr>
 107 <tr>
 108 <td class="function_type">
 109 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 110 </td>
 111 <td class="function_name">
 112 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set" title="gsignond_dictionary_set ()">gsignond_dictionary_set</a> <span class="c_punctuation">()</span>
 113 </td>
 114 </tr>
 115 <tr>
 116 <td class="function_type">
 117 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 118 </td>
 119 <td class="function_name">
 120 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-boolean" title="gsignond_dictionary_get_boolean ()">gsignond_dictionary_get_boolean</a> <span class="c_punctuation">()</span>
 121 </td>
 122 </tr>
 123 <tr>
 124 <td class="function_type">
 125 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 126 </td>
 127 <td class="function_name">
 128 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-boolean" title="gsignond_dictionary_set_boolean ()">gsignond_dictionary_set_boolean</a> <span class="c_punctuation">()</span>
 129 </td>
 130 </tr>
 131 <tr>
 132 <td class="function_type">
 133 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 134 </td>
 135 <td class="function_name">
 136 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int32" title="gsignond_dictionary_get_int32 ()">gsignond_dictionary_get_int32</a> <span class="c_punctuation">()</span>
 137 </td>
 138 </tr>
 139 <tr>
 140 <td class="function_type">
 141 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 142 </td>
 143 <td class="function_name">
 144 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int32" title="gsignond_dictionary_set_int32 ()">gsignond_dictionary_set_int32</a> <span class="c_punctuation">()</span>
 145 </td>
 146 </tr>
 147 <tr>
 148 <td class="function_type">
 149 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 150 </td>
 151 <td class="function_name">
 152 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint32" title="gsignond_dictionary_get_uint32 ()">gsignond_dictionary_get_uint32</a> <span class="c_punctuation">()</span>
 153 </td>
 154 </tr>
 155 <tr>
 156 <td class="function_type">
 157 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 158 </td>
 159 <td class="function_name">
 160 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint32" title="gsignond_dictionary_set_uint32 ()">gsignond_dictionary_set_uint32</a> <span class="c_punctuation">()</span>
 161 </td>
 162 </tr>
 163 <tr>
 164 <td class="function_type">
 165 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 166 </td>
 167 <td class="function_name">
 168 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int64" title="gsignond_dictionary_get_int64 ()">gsignond_dictionary_get_int64</a> <span class="c_punctuation">()</span>
 169 </td>
 170 </tr>
 171 <tr>
 172 <td class="function_type">
 173 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 174 </td>
 175 <td class="function_name">
 176 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int64" title="gsignond_dictionary_set_int64 ()">gsignond_dictionary_set_int64</a> <span class="c_punctuation">()</span>
 177 </td>
 178 </tr>
 179 <tr>
 180 <td class="function_type">
 181 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 182 </td>
 183 <td class="function_name">
 184 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint64" title="gsignond_dictionary_get_uint64 ()">gsignond_dictionary_get_uint64</a> <span class="c_punctuation">()</span>
 185 </td>
 186 </tr>
 187 <tr>
 188 <td class="function_type">
 189 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 190 </td>
 191 <td class="function_name">
 192 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint64" title="gsignond_dictionary_set_uint64 ()">gsignond_dictionary_set_uint64</a> <span class="c_punctuation">()</span>
 193 </td>
 194 </tr>
 195 <tr>
 196 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 197 </td>
 198 <td class="function_name">
 199 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-string" title="gsignond_dictionary_get_string ()">gsignond_dictionary_get_string</a> <span class="c_punctuation">()</span>
 200 </td>
 201 </tr>
 202 <tr>
 203 <td class="function_type">
 204 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 205 </td>
 206 <td class="function_name">
 207 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-string" title="gsignond_dictionary_set_string ()">gsignond_dictionary_set_string</a> <span class="c_punctuation">()</span>
 208 </td>
 209 </tr>
 210 <tr>
 211 <td class="function_type">
 212 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 213 </td>
 214 <td class="function_name">
 215 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-remove" title="gsignond_dictionary_remove ()">gsignond_dictionary_remove</a> <span class="c_punctuation">()</span>
 216 </td>
 217 </tr>
 218 <tr>
 219 <td class="function_type">
 220 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 221 </td>
 222 <td class="function_name">
 223 <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-contains" title="gsignond_dictionary_contains ()">gsignond_dictionary_contains</a> <span class="c_punctuation">()</span>
 224 </td>
 225 </tr>
 226 </tbody>
 227 </table></div>
 228 </div>
 229 <div class="refsect1">
 230 <a name="gsignond-GSignondDictionary.object-hierarchy"></a><h2>Object Hierarchy</h2>
 231 <pre class="screen">
 232 </pre>
 233 </div>
 234 <div class="refsect1">
 235 <a name="gsignond-GSignondDictionary.includes"></a><h2>Includes</h2>
 236 <pre class="synopsis">#include &lt;gsignond/gsignond-dictionary.h&gt;
 237 </pre>
 238 </div>
 239 <div class="refsect1">
 240 <a name="gsignond-GSignondDictionary.description"></a><h2>Description</h2>
 241 <p>A <span class="type">GSignondDictionary</span> is a dictionary data structure that maps string keys to <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> values.
 242 It's used in multiple places in gsignond and its public API to pass key-value
 243 data sets.</p>
 244 <div class="informalexample"><pre class="programlisting">
 245     gsignond_dictionary_set_string(dict, "name", "John Smith");
 246     gsignond_dictionary_set_uint32(dict, "age", 32);
 247
 248     guint32 age;
 249     gboolean success = gsignond_dictionary_get_uint32(dict, "age", &amp;age);
 250     const gchar* name = gsignond_dictionary_get_string(dict, "name");
 251     gsignond_dictionary_unref(dict);
 252 </pre></div>
 253 <p></p>
 254 </div>
 255 <div class="refsect1">
 256 <a name="gsignond-GSignondDictionary.functions_details"></a><h2>Functions</h2>
 257 <div class="refsect2">
 258 <a name="gsignond-dictionary-new"></a><h3>gsignond_dictionary_new ()</h3>
 259 <pre class="programlisting"><span class="returnvalue">GSignondDictionary</span> *
 260 gsignond_dictionary_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 261 <p>Creates a new instance of <span class="type">GSignondDictionary</span>.</p>
 262 <div class="refsect3">
 263 <a name="id-1.5.3.7.2.5"></a><h4>Returns</h4>
 264 <p> <span class="type">GSignondDictionary</span> object if successful,
 265 NULL otherwise. </p>
 266 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 267 </div>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="gsignond-dictionary-ref"></a><h3>gsignond_dictionary_ref ()</h3>
 272 <pre class="programlisting"><span class="returnvalue">GSignondDictionary</span> *
 273 gsignond_dictionary_ref (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>);</pre>
 274 <p>Increments the reference count of the dictionary structure.</p>
 275 <div class="refsect3">
 276 <a name="id-1.5.3.7.3.5"></a><h4>Parameters</h4>
 277 <div class="informaltable"><table width="100%" border="0">
 278 <colgroup>
 279 <col width="150px" class="parameters_name">
 280 <col class="parameters_description">
 281 <col width="200px" class="parameters_annotations">
 282 </colgroup>
 283 <tbody><tr>
 284 <td class="parameter_name"><p>dict</p></td>
 285 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 286 <td class="parameter_annotations"> </td>
 287 </tr></tbody>
 288 </table></div>
 289 </div>
 290 <div class="refsect3">
 291 <a name="id-1.5.3.7.3.6"></a><h4>Returns</h4>
 292 <p> the pointer to the passed in <span class="type">GSignondDictionary</span></p>
 293 <p></p>
 294 </div>
 295 </div>
 296 <hr>
 297 <div class="refsect2">
 298 <a name="gsignond-dictionary-unref"></a><h3>gsignond_dictionary_unref ()</h3>
 299 <pre class="programlisting"><span class="returnvalue">void</span>
 300 gsignond_dictionary_unref (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>);</pre>
 301 <p>Decrements the reference count of the dictionary structure. If the reference
 302 count reaches zero, the structure is deallocated and shouldn't be used.</p>
 303 <div class="refsect3">
 304 <a name="id-1.5.3.7.4.5"></a><h4>Parameters</h4>
 305 <div class="informaltable"><table width="100%" border="0">
 306 <colgroup>
 307 <col width="150px" class="parameters_name">
 308 <col class="parameters_description">
 309 <col width="200px" class="parameters_annotations">
 310 </colgroup>
 311 <tbody><tr>
 312 <td class="parameter_name"><p>dict</p></td>
 313 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 314 <td class="parameter_annotations"> </td>
 315 </tr></tbody>
 316 </table></div>
 317 </div>
 318 </div>
 319 <hr>
 320 <div class="refsect2">
 321 <a name="gsignond-dictionary-copy"></a><h3>gsignond_dictionary_copy ()</h3>
 322 <pre class="programlisting"><span class="returnvalue">GSignondDictionary</span> *
 323 gsignond_dictionary_copy (<em class="parameter"><code><span class="type">GSignondDictionary</span> *other</code></em>);</pre>
 324 <p>Creates a copy of the dictionary.</p>
 325 <div class="refsect3">
 326 <a name="id-1.5.3.7.5.5"></a><h4>Parameters</h4>
 327 <div class="informaltable"><table width="100%" border="0">
 328 <colgroup>
 329 <col width="150px" class="parameters_name">
 330 <col class="parameters_description">
 331 <col width="200px" class="parameters_annotations">
 332 </colgroup>
 333 <tbody><tr>
 334 <td class="parameter_name"><p>other</p></td>
 335 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 336 <td class="parameter_annotations"> </td>
 337 </tr></tbody>
 338 </table></div>
 339 </div>
 340 <div class="refsect3">
 341 <a name="id-1.5.3.7.5.6"></a><h4>Returns</h4>
 342 <p> <span class="type">GSignondDictionary</span> object if the copy was successful,
 343 NULL otherwise. </p>
 344 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 345 </div>
 346 </div>
 347 <hr>
 348 <div class="refsect2">
 349 <a name="gsignond-dictionary-new-from-variant"></a><h3>gsignond_dictionary_new_from_variant ()</h3>
 350 <pre class="programlisting"><span class="returnvalue">GSignondDictionary</span> *
 351 gsignond_dictionary_new_from_variant (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre>
 352 <p>Converts the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to <span class="type">GSignondDictionary</span>. This is useful for example if
 353 the dictionary needs to be deserialized, or if it's contained in another
 354 <span class="type">GSignondDictionary</span> and has been retrieved using <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get" title="gsignond_dictionary_get ()"><code class="function">gsignond_dictionary_get()</code></a>.</p>
 355 <div class="refsect3">
 356 <a name="id-1.5.3.7.6.5"></a><h4>Parameters</h4>
 357 <div class="informaltable"><table width="100%" border="0">
 358 <colgroup>
 359 <col width="150px" class="parameters_name">
 360 <col class="parameters_description">
 361 <col width="200px" class="parameters_annotations">
 362 </colgroup>
 363 <tbody><tr>
 364 <td class="parameter_name"><p>variant</p></td>
 365 <td class="parameter_description"><p>instance of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a></p></td>
 366 <td class="parameter_annotations"> </td>
 367 </tr></tbody>
 368 </table></div>
 369 </div>
 370 <div class="refsect3">
 371 <a name="id-1.5.3.7.6.6"></a><h4>Returns</h4>
 372 <p> <span class="type">GSignondDictionary</span> if successful, NULL otherwise. </p>
 373 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 374 </div>
 375 </div>
 376 <hr>
 377 <div class="refsect2">
 378 <a name="gsignond-dictionary-to-variant"></a><h3>gsignond_dictionary_to_variant ()</h3>
 379 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 380 gsignond_dictionary_to_variant (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>);</pre>
 381 <p>Converts the <span class="type">GSignondDictionary</span> to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. The result can be serialized
 382 or put into another <span class="type">GSignondDictionary</span> using <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set" title="gsignond_dictionary_set ()"><code class="function">gsignond_dictionary_set()</code></a>.</p>
 383 <div class="refsect3">
 384 <a name="id-1.5.3.7.7.5"></a><h4>Parameters</h4>
 385 <div class="informaltable"><table width="100%" border="0">
 386 <colgroup>
 387 <col width="150px" class="parameters_name">
 388 <col class="parameters_description">
 389 <col width="200px" class="parameters_annotations">
 390 </colgroup>
 391 <tbody><tr>
 392 <td class="parameter_name"><p>dict</p></td>
 393 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 394 <td class="parameter_annotations"> </td>
 395 </tr></tbody>
 396 </table></div>
 397 </div>
 398 <div class="refsect3">
 399 <a name="id-1.5.3.7.7.6"></a><h4>Returns</h4>
 400 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> object if successful, NULL otherwise. </p>
 401 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 402 </div>
 403 </div>
 404 <hr>
 405 <div class="refsect2">
 406 <a name="gsignond-dictionary-to-variant-builder"></a><h3>gsignond_dictionary_to_variant_builder ()</h3>
 407 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="returnvalue">GVariantBuilder</span></a> *
 408 gsignond_dictionary_to_variant_builder
 409                                (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>);</pre>
 410 <p>Converts the <span class="type">GSignondDictionary</span> to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a> of type
 411 G_VARIANT_TYPE_VARDICT.</p>
 412 <p>Caller should use <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-builder-unref"><code class="function">g_variant_builder_unref()</code></a> on the return value when it is
 413 no longer needed.</p>
 414 <div class="refsect3">
 415 <a name="id-1.5.3.7.8.6"></a><h4>Parameters</h4>
 416 <div class="informaltable"><table width="100%" border="0">
 417 <colgroup>
 418 <col width="150px" class="parameters_name">
 419 <col class="parameters_description">
 420 <col width="200px" class="parameters_annotations">
 421 </colgroup>
 422 <tbody><tr>
 423 <td class="parameter_name"><p>dict</p></td>
 424 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 425 <td class="parameter_annotations"> </td>
 426 </tr></tbody>
 427 </table></div>
 428 </div>
 429 <div class="refsect3">
 430 <a name="id-1.5.3.7.8.7"></a><h4>Returns</h4>
 431 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a> if successful, NULL otherwise. </p>
 432 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 433 </div>
 434 </div>
 435 <hr>
 436 <div class="refsect2">
 437 <a name="gsignond-dictionary-get"></a><h3>gsignond_dictionary_get ()</h3>
 438 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 439 gsignond_dictionary_get (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 440                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
 441 <p>Retrieves a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> value from the dictionary. This can be used to retrieve
 442 a value of an arbitrary type, and then convert it manually to a specific type
 443 using <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> methods. For most commonly used types, also getters that
 444 return the specific type directly are provided (<a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-string" title="gsignond_dictionary_get_string ()"><code class="function">gsignond_dictionary_get_string()</code></a>
 445 and similar).</p>
 446 <div class="refsect3">
 447 <a name="id-1.5.3.7.9.5"></a><h4>Parameters</h4>
 448 <div class="informaltable"><table width="100%" border="0">
 449 <colgroup>
 450 <col width="150px" class="parameters_name">
 451 <col class="parameters_description">
 452 <col width="200px" class="parameters_annotations">
 453 </colgroup>
 454 <tbody>
 455 <tr>
 456 <td class="parameter_name"><p>dict</p></td>
 457 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 458 <td class="parameter_annotations"> </td>
 459 </tr>
 460 <tr>
 461 <td class="parameter_name"><p>key</p></td>
 462 <td class="parameter_description"><p>the key to look up in the dictionary</p></td>
 463 <td class="parameter_annotations"> </td>
 464 </tr>
 465 </tbody>
 466 </table></div>
 467 </div>
 468 <div class="refsect3">
 469 <a name="id-1.5.3.7.9.6"></a><h4>Returns</h4>
 470 <p> the value; NULL is returned in case of failure (for
 471 example if the entry corresponding to the supplied key doesn't exist). </p>
 472 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 473 </div>
 474 </div>
 475 <hr>
 476 <div class="refsect2">
 477 <a name="gsignond-dictionary-set"></a><h3>gsignond_dictionary_set ()</h3>
 478 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 479 gsignond_dictionary_set (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 480                          <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 481                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
 482 <p>Adds or replaces key-value pair in the dictionary. This allows to set a value
 483 of an arbitrary type: it first needs to be converted to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. For most
 484 commonly used types also type-specific setters are provided.</p>
 485 <div class="refsect3">
 486 <a name="id-1.5.3.7.10.5"></a><h4>Parameters</h4>
 487 <div class="informaltable"><table width="100%" border="0">
 488 <colgroup>
 489 <col width="150px" class="parameters_name">
 490 <col class="parameters_description">
 491 <col width="200px" class="parameters_annotations">
 492 </colgroup>
 493 <tbody>
 494 <tr>
 495 <td class="parameter_name"><p>dict</p></td>
 496 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 497 <td class="parameter_annotations"> </td>
 498 </tr>
 499 <tr>
 500 <td class="parameter_name"><p>key</p></td>
 501 <td class="parameter_description"><p> key to be set. </p></td>
 502 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 503 </tr>
 504 <tr>
 505 <td class="parameter_name"><p>value</p></td>
 506 <td class="parameter_description"><p> value to be set. </p></td>
 507 <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
 508 </tr>
 509 </tbody>
 510 </table></div>
 511 </div>
 512 <div class="refsect3">
 513 <a name="id-1.5.3.7.10.6"></a><h4>Returns</h4>
 514 <p> TRUE if successful, FALSE otherwise.</p>
 515 <p></p>
 516 </div>
 517 </div>
 518 <hr>
 519 <div class="refsect2">
 520 <a name="gsignond-dictionary-get-boolean"></a><h3>gsignond_dictionary_get_boolean ()</h3>
 521 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 522 gsignond_dictionary_get_boolean (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 523                                  <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 524                                  <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *value</code></em>);</pre>
 525 <p>Retrieves a gboolean value.</p>
 526 <div class="refsect3">
 527 <a name="id-1.5.3.7.11.5"></a><h4>Parameters</h4>
 528 <div class="informaltable"><table width="100%" border="0">
 529 <colgroup>
 530 <col width="150px" class="parameters_name">
 531 <col class="parameters_description">
 532 <col width="200px" class="parameters_annotations">
 533 </colgroup>
 534 <tbody>
 535 <tr>
 536 <td class="parameter_name"><p>dict</p></td>
 537 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 538 <td class="parameter_annotations"> </td>
 539 </tr>
 540 <tr>
 541 <td class="parameter_name"><p>key</p></td>
 542 <td class="parameter_description"><p> key to look up. </p></td>
 543 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 544 </tr>
 545 <tr>
 546 <td class="parameter_name"><p>value</p></td>
 547 <td class="parameter_description"><p>points to the location where the value should be set</p></td>
 548 <td class="parameter_annotations"> </td>
 549 </tr>
 550 </tbody>
 551 </table></div>
 552 </div>
 553 <div class="refsect3">
 554 <a name="id-1.5.3.7.11.6"></a><h4>Returns</h4>
 555 <p> TRUE if the value was retrieved successfully, FALSE otherwise.</p>
 556 <p></p>
 557 </div>
 558 </div>
 559 <hr>
 560 <div class="refsect2">
 561 <a name="gsignond-dictionary-set-boolean"></a><h3>gsignond_dictionary_set_boolean ()</h3>
 562 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 563 gsignond_dictionary_set_boolean (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 564                                  <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 565                                  <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
 566 <p>Sets or replaces a gboolean value in the dictionary.</p>
 567 <div class="refsect3">
 568 <a name="id-1.5.3.7.12.5"></a><h4>Parameters</h4>
 569 <div class="informaltable"><table width="100%" border="0">
 570 <colgroup>
 571 <col width="150px" class="parameters_name">
 572 <col class="parameters_description">
 573 <col width="200px" class="parameters_annotations">
 574 </colgroup>
 575 <tbody>
 576 <tr>
 577 <td class="parameter_name"><p>dict</p></td>
 578 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 579 <td class="parameter_annotations"> </td>
 580 </tr>
 581 <tr>
 582 <td class="parameter_name"><p>key</p></td>
 583 <td class="parameter_description"><p> key to set. </p></td>
 584 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 585 </tr>
 586 <tr>
 587 <td class="parameter_name"><p>value</p></td>
 588 <td class="parameter_description"><p>value to set</p></td>
 589 <td class="parameter_annotations"> </td>
 590 </tr>
 591 </tbody>
 592 </table></div>
 593 </div>
 594 <div class="refsect3">
 595 <a name="id-1.5.3.7.12.6"></a><h4>Returns</h4>
 596 <p> TRUE if the value was set or replaced successfully, FALSE otherwise.</p>
 597 <p></p>
 598 </div>
 599 </div>
 600 <hr>
 601 <div class="refsect2">
 602 <a name="gsignond-dictionary-get-int32"></a><h3>gsignond_dictionary_get_int32 ()</h3>
 603 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 604 gsignond_dictionary_get_int32 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 605                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 606                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value</code></em>);</pre>
 607 <p>Retrieves a int32 value.</p>
 608 <div class="refsect3">
 609 <a name="id-1.5.3.7.13.5"></a><h4>Parameters</h4>
 610 <div class="informaltable"><table width="100%" border="0">
 611 <colgroup>
 612 <col width="150px" class="parameters_name">
 613 <col class="parameters_description">
 614 <col width="200px" class="parameters_annotations">
 615 </colgroup>
 616 <tbody>
 617 <tr>
 618 <td class="parameter_name"><p>dict</p></td>
 619 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 620 <td class="parameter_annotations"> </td>
 621 </tr>
 622 <tr>
 623 <td class="parameter_name"><p>key</p></td>
 624 <td class="parameter_description"><p> key to look up. </p></td>
 625 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 626 </tr>
 627 <tr>
 628 <td class="parameter_name"><p>value</p></td>
 629 <td class="parameter_description"><p>points to the location where the value should be set</p></td>
 630 <td class="parameter_annotations"> </td>
 631 </tr>
 632 </tbody>
 633 </table></div>
 634 </div>
 635 <div class="refsect3">
 636 <a name="id-1.5.3.7.13.6"></a><h4>Returns</h4>
 637 <p> TRUE if the value was retrieved successfully, FALSE otherwise.</p>
 638 <p></p>
 639 </div>
 640 </div>
 641 <hr>
 642 <div class="refsect2">
 643 <a name="gsignond-dictionary-set-int32"></a><h3>gsignond_dictionary_set_int32 ()</h3>
 644 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 645 gsignond_dictionary_set_int32 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 646                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 647                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
 648 <p>Sets or replaces a int32 value in the dictionary.</p>
 649 <div class="refsect3">
 650 <a name="id-1.5.3.7.14.5"></a><h4>Parameters</h4>
 651 <div class="informaltable"><table width="100%" border="0">
 652 <colgroup>
 653 <col width="150px" class="parameters_name">
 654 <col class="parameters_description">
 655 <col width="200px" class="parameters_annotations">
 656 </colgroup>
 657 <tbody>
 658 <tr>
 659 <td class="parameter_name"><p>dict</p></td>
 660 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 661 <td class="parameter_annotations"> </td>
 662 </tr>
 663 <tr>
 664 <td class="parameter_name"><p>key</p></td>
 665 <td class="parameter_description"><p> key to set. </p></td>
 666 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 667 </tr>
 668 <tr>
 669 <td class="parameter_name"><p>value</p></td>
 670 <td class="parameter_description"><p>value to set</p></td>
 671 <td class="parameter_annotations"> </td>
 672 </tr>
 673 </tbody>
 674 </table></div>
 675 </div>
 676 <div class="refsect3">
 677 <a name="id-1.5.3.7.14.6"></a><h4>Returns</h4>
 678 <p> TRUE if the value was set or replaced successfully, FALSE otherwise.</p>
 679 <p></p>
 680 </div>
 681 </div>
 682 <hr>
 683 <div class="refsect2">
 684 <a name="gsignond-dictionary-get-uint32"></a><h3>gsignond_dictionary_get_uint32 ()</h3>
 685 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 686 gsignond_dictionary_get_uint32 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 687                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 688                                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *value</code></em>);</pre>
 689 <p>Retrieves a uint32 value.</p>
 690 <div class="refsect3">
 691 <a name="id-1.5.3.7.15.5"></a><h4>Parameters</h4>
 692 <div class="informaltable"><table width="100%" border="0">
 693 <colgroup>
 694 <col width="150px" class="parameters_name">
 695 <col class="parameters_description">
 696 <col width="200px" class="parameters_annotations">
 697 </colgroup>
 698 <tbody>
 699 <tr>
 700 <td class="parameter_name"><p>dict</p></td>
 701 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 702 <td class="parameter_annotations"> </td>
 703 </tr>
 704 <tr>
 705 <td class="parameter_name"><p>key</p></td>
 706 <td class="parameter_description"><p> key to look up. </p></td>
 707 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 708 </tr>
 709 <tr>
 710 <td class="parameter_name"><p>value</p></td>
 711 <td class="parameter_description"><p>points to the location where the value should be set</p></td>
 712 <td class="parameter_annotations"> </td>
 713 </tr>
 714 </tbody>
 715 </table></div>
 716 </div>
 717 <div class="refsect3">
 718 <a name="id-1.5.3.7.15.6"></a><h4>Returns</h4>
 719 <p> TRUE if the value was retrieved successfully, FALSE otherwise.</p>
 720 <p></p>
 721 </div>
 722 </div>
 723 <hr>
 724 <div class="refsect2">
 725 <a name="gsignond-dictionary-set-uint32"></a><h3>gsignond_dictionary_set_uint32 ()</h3>
 726 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 727 gsignond_dictionary_set_uint32 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 728                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 729                                 <em class="parameter"><code><span class="type">guint32</span> value</code></em>);</pre>
 730 <p>Sets or replaces a uint32 value in the dictionary.</p>
 731 <div class="refsect3">
 732 <a name="id-1.5.3.7.16.5"></a><h4>Parameters</h4>
 733 <div class="informaltable"><table width="100%" border="0">
 734 <colgroup>
 735 <col width="150px" class="parameters_name">
 736 <col class="parameters_description">
 737 <col width="200px" class="parameters_annotations">
 738 </colgroup>
 739 <tbody>
 740 <tr>
 741 <td class="parameter_name"><p>dict</p></td>
 742 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 743 <td class="parameter_annotations"> </td>
 744 </tr>
 745 <tr>
 746 <td class="parameter_name"><p>key</p></td>
 747 <td class="parameter_description"><p> key to set. </p></td>
 748 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 749 </tr>
 750 <tr>
 751 <td class="parameter_name"><p>value</p></td>
 752 <td class="parameter_description"><p>value to set</p></td>
 753 <td class="parameter_annotations"> </td>
 754 </tr>
 755 </tbody>
 756 </table></div>
 757 </div>
 758 <div class="refsect3">
 759 <a name="id-1.5.3.7.16.6"></a><h4>Returns</h4>
 760 <p> TRUE if the value was set or replaced successfully, FALSE otherwise.</p>
 761 <p></p>
 762 </div>
 763 </div>
 764 <hr>
 765 <div class="refsect2">
 766 <a name="gsignond-dictionary-get-int64"></a><h3>gsignond_dictionary_get_int64 ()</h3>
 767 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 768 gsignond_dictionary_get_int64 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 769                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 770                                <em class="parameter"><code><span class="type">gint64</span> *value</code></em>);</pre>
 771 <p>Retrieves a int64 value.</p>
 772 <div class="refsect3">
 773 <a name="id-1.5.3.7.17.5"></a><h4>Parameters</h4>
 774 <div class="informaltable"><table width="100%" border="0">
 775 <colgroup>
 776 <col width="150px" class="parameters_name">
 777 <col class="parameters_description">
 778 <col width="200px" class="parameters_annotations">
 779 </colgroup>
 780 <tbody>
 781 <tr>
 782 <td class="parameter_name"><p>dict</p></td>
 783 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 784 <td class="parameter_annotations"> </td>
 785 </tr>
 786 <tr>
 787 <td class="parameter_name"><p>key</p></td>
 788 <td class="parameter_description"><p> key to look up. </p></td>
 789 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 790 </tr>
 791 <tr>
 792 <td class="parameter_name"><p>value</p></td>
 793 <td class="parameter_description"><p>points to the location where the value should be set</p></td>
 794 <td class="parameter_annotations"> </td>
 795 </tr>
 796 </tbody>
 797 </table></div>
 798 </div>
 799 <div class="refsect3">
 800 <a name="id-1.5.3.7.17.6"></a><h4>Returns</h4>
 801 <p> TRUE if the value was retrieved successfully, FALSE otherwise.</p>
 802 <p></p>
 803 </div>
 804 </div>
 805 <hr>
 806 <div class="refsect2">
 807 <a name="gsignond-dictionary-set-int64"></a><h3>gsignond_dictionary_set_int64 ()</h3>
 808 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 809 gsignond_dictionary_set_int64 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 810                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 811                                <em class="parameter"><code><span class="type">gint64</span> value</code></em>);</pre>
 812 <p>Sets or replaces a int64 value in the dictionary.</p>
 813 <div class="refsect3">
 814 <a name="id-1.5.3.7.18.5"></a><h4>Parameters</h4>
 815 <div class="informaltable"><table width="100%" border="0">
 816 <colgroup>
 817 <col width="150px" class="parameters_name">
 818 <col class="parameters_description">
 819 <col width="200px" class="parameters_annotations">
 820 </colgroup>
 821 <tbody>
 822 <tr>
 823 <td class="parameter_name"><p>dict</p></td>
 824 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 825 <td class="parameter_annotations"> </td>
 826 </tr>
 827 <tr>
 828 <td class="parameter_name"><p>key</p></td>
 829 <td class="parameter_description"><p> key to set. </p></td>
 830 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 831 </tr>
 832 <tr>
 833 <td class="parameter_name"><p>value</p></td>
 834 <td class="parameter_description"><p>value to set</p></td>
 835 <td class="parameter_annotations"> </td>
 836 </tr>
 837 </tbody>
 838 </table></div>
 839 </div>
 840 <div class="refsect3">
 841 <a name="id-1.5.3.7.18.6"></a><h4>Returns</h4>
 842 <p> TRUE if the value was set or replaced successfully, FALSE otherwise.</p>
 843 <p></p>
 844 </div>
 845 </div>
 846 <hr>
 847 <div class="refsect2">
 848 <a name="gsignond-dictionary-get-uint64"></a><h3>gsignond_dictionary_get_uint64 ()</h3>
 849 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 850 gsignond_dictionary_get_uint64 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 851                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 852                                 <em class="parameter"><code><span class="type">guint64</span> *value</code></em>);</pre>
 853 <p>Retrieves a uint64 value.</p>
 854 <div class="refsect3">
 855 <a name="id-1.5.3.7.19.5"></a><h4>Parameters</h4>
 856 <div class="informaltable"><table width="100%" border="0">
 857 <colgroup>
 858 <col width="150px" class="parameters_name">
 859 <col class="parameters_description">
 860 <col width="200px" class="parameters_annotations">
 861 </colgroup>
 862 <tbody>
 863 <tr>
 864 <td class="parameter_name"><p>dict</p></td>
 865 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 866 <td class="parameter_annotations"> </td>
 867 </tr>
 868 <tr>
 869 <td class="parameter_name"><p>key</p></td>
 870 <td class="parameter_description"><p> key to look up. </p></td>
 871 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 872 </tr>
 873 <tr>
 874 <td class="parameter_name"><p>value</p></td>
 875 <td class="parameter_description"><p>points to the location where the value should be set</p></td>
 876 <td class="parameter_annotations"> </td>
 877 </tr>
 878 </tbody>
 879 </table></div>
 880 </div>
 881 <div class="refsect3">
 882 <a name="id-1.5.3.7.19.6"></a><h4>Returns</h4>
 883 <p> TRUE if the value was retrieved successfully, FALSE otherwise.</p>
 884 <p></p>
 885 </div>
 886 </div>
 887 <hr>
 888 <div class="refsect2">
 889 <a name="gsignond-dictionary-set-uint64"></a><h3>gsignond_dictionary_set_uint64 ()</h3>
 890 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 891 gsignond_dictionary_set_uint64 (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 892                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 893                                 <em class="parameter"><code><span class="type">guint64</span> value</code></em>);</pre>
 894 <p>Sets or replaces a uint64 value in the dictionary.</p>
 895 <div class="refsect3">
 896 <a name="id-1.5.3.7.20.5"></a><h4>Parameters</h4>
 897 <div class="informaltable"><table width="100%" border="0">
 898 <colgroup>
 899 <col width="150px" class="parameters_name">
 900 <col class="parameters_description">
 901 <col width="200px" class="parameters_annotations">
 902 </colgroup>
 903 <tbody>
 904 <tr>
 905 <td class="parameter_name"><p>dict</p></td>
 906 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 907 <td class="parameter_annotations"> </td>
 908 </tr>
 909 <tr>
 910 <td class="parameter_name"><p>key</p></td>
 911 <td class="parameter_description"><p> key to set. </p></td>
 912 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 913 </tr>
 914 <tr>
 915 <td class="parameter_name"><p>value</p></td>
 916 <td class="parameter_description"><p>value to set</p></td>
 917 <td class="parameter_annotations"> </td>
 918 </tr>
 919 </tbody>
 920 </table></div>
 921 </div>
 922 <div class="refsect3">
 923 <a name="id-1.5.3.7.20.6"></a><h4>Returns</h4>
 924 <p> TRUE if the value was set or replaced successfully, FALSE otherwise.</p>
 925 <p></p>
 926 </div>
 927 </div>
 928 <hr>
 929 <div class="refsect2">
 930 <a name="gsignond-dictionary-get-string"></a><h3>gsignond_dictionary_get_string ()</h3>
 931 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 932 gsignond_dictionary_get_string (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 933                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
 934 <p>Retrieves a string value.</p>
 935 <div class="refsect3">
 936 <a name="id-1.5.3.7.21.5"></a><h4>Parameters</h4>
 937 <div class="informaltable"><table width="100%" border="0">
 938 <colgroup>
 939 <col width="150px" class="parameters_name">
 940 <col class="parameters_description">
 941 <col width="200px" class="parameters_annotations">
 942 </colgroup>
 943 <tbody>
 944 <tr>
 945 <td class="parameter_name"><p>dict</p></td>
 946 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 947 <td class="parameter_annotations"> </td>
 948 </tr>
 949 <tr>
 950 <td class="parameter_name"><p>key</p></td>
 951 <td class="parameter_description"><p> key to look up. </p></td>
 952 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 953 </tr>
 954 </tbody>
 955 </table></div>
 956 </div>
 957 <div class="refsect3">
 958 <a name="id-1.5.3.7.21.6"></a><h4>Returns</h4>
 959 <p> the value if it was retrieved successfully, NULL otherwise. </p>
 960 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 961 </div>
 962 </div>
 963 <hr>
 964 <div class="refsect2">
 965 <a name="gsignond-dictionary-set-string"></a><h3>gsignond_dictionary_set_string ()</h3>
 966 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 967 gsignond_dictionary_set_string (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
 968                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
 969                                 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
 970 <p>Sets or replaces a string value in the dictionary.</p>
 971 <div class="refsect3">
 972 <a name="id-1.5.3.7.22.5"></a><h4>Parameters</h4>
 973 <div class="informaltable"><table width="100%" border="0">
 974 <colgroup>
 975 <col width="150px" class="parameters_name">
 976 <col class="parameters_description">
 977 <col width="200px" class="parameters_annotations">
 978 </colgroup>
 979 <tbody>
 980 <tr>
 981 <td class="parameter_name"><p>dict</p></td>
 982 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
 983 <td class="parameter_annotations"> </td>
 984 </tr>
 985 <tr>
 986 <td class="parameter_name"><p>key</p></td>
 987 <td class="parameter_description"><p> key to set. </p></td>
 988 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 989 </tr>
 990 <tr>
 991 <td class="parameter_name"><p>value</p></td>
 992 <td class="parameter_description"><p> value to set. </p></td>
 993 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 994 </tr>
 995 </tbody>
 996 </table></div>
 997 </div>
 998 <div class="refsect3">
 999 <a name="id-1.5.3.7.22.6"></a><h4>Returns</h4>
1000 <p> TRUE if the value was set or replaced successfully, FALSE otherwise.</p>
1001 <p></p>
1002 </div>
1003 </div>
1004 <hr>
1005 <div class="refsect2">
1006 <a name="gsignond-dictionary-remove"></a><h3>gsignond_dictionary_remove ()</h3>
1007 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1008 gsignond_dictionary_remove (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
1009                             <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
1010 <p>Removes key-value pair in the dictionary as per key.</p>
1011 <div class="refsect3">
1012 <a name="id-1.5.3.7.23.5"></a><h4>Parameters</h4>
1013 <div class="informaltable"><table width="100%" border="0">
1014 <colgroup>
1015 <col width="150px" class="parameters_name">
1016 <col class="parameters_description">
1017 <col width="200px" class="parameters_annotations">
1018 </colgroup>
1019 <tbody>
1020 <tr>
1021 <td class="parameter_name"><p>dict</p></td>
1022 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
1023 <td class="parameter_annotations"> </td>
1024 </tr>
1025 <tr>
1026 <td class="parameter_name"><p>key</p></td>
1027 <td class="parameter_description"><p> key which needs to be removed from the dictionary. </p></td>
1028 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
1029 </tr>
1030 </tbody>
1031 </table></div>
1032 </div>
1033 <div class="refsect3">
1034 <a name="id-1.5.3.7.23.6"></a><h4>Returns</h4>
1035 <p> TRUE if successful, FALSE otherwise.</p>
1036 <p></p>
1037 </div>
1038 </div>
1039 <hr>
1040 <div class="refsect2">
1041 <a name="gsignond-dictionary-contains"></a><h3>gsignond_dictionary_contains ()</h3>
1042 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
1043 gsignond_dictionary_contains (<em class="parameter"><code><span class="type">GSignondDictionary</span> *dict</code></em>,
1044                               <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
1045 <p>Checks if the <em class="parameter"><code>dict</code></em>
1046  contains <em class="parameter"><code>key</code></em>
1047 .</p>
1048 <div class="refsect3">
1049 <a name="id-1.5.3.7.24.5"></a><h4>Parameters</h4>
1050 <div class="informaltable"><table width="100%" border="0">
1051 <colgroup>
1052 <col width="150px" class="parameters_name">
1053 <col class="parameters_description">
1054 <col width="200px" class="parameters_annotations">
1055 </colgroup>
1056 <tbody>
1057 <tr>
1058 <td class="parameter_name"><p>dict</p></td>
1059 <td class="parameter_description"><p>instance of <span class="type">GSignondDictionary</span></p></td>
1060 <td class="parameter_annotations"> </td>
1061 </tr>
1062 <tr>
1063 <td class="parameter_name"><p>key</p></td>
1064 <td class="parameter_description"><p> key to check. </p></td>
1065 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
1066 </tr>
1067 </tbody>
1068 </table></div>
1069 </div>
1070 <div class="refsect3">
1071 <a name="id-1.5.3.7.24.6"></a><h4>Returns</h4>
1072 <p> TRUE if found, FALSE otherwise.</p>
1073 <p></p>
1074 </div>
1075 </div>
1076 </div>
1077 <div class="refsect1">
1078 <a name="gsignond-GSignondDictionary.other_details"></a><h2>Types and Values</h2>
1079 </div>
1080 </div>
1081 <div class="footer">
1082 <hr>
1083           Generated by GTK-Doc V1.20</div>
1084 </body>
1085 </html>