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>GSignondDictionary</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch03.html" title="GSignond API for writing authentication plugins">
   9 <link rel="prev" href="gsignond-GSignondPlugin.html" title="GSignondPlugin">
  10 <link rel="next" href="gsignond-GSignondSessionData.html" title="GSignondSessionData">
  11 <meta name="generator" content="GTK-Doc V1.19.1 (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">
  17 <a href="#" class="shortcut">Top</a>
  18                    |
  19                   <a href="#gsignond-GSignondDictionary.description" class="shortcut">Description</a>
  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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="gsignond-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 valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsynopsisdiv">
  36 <a name="gsignond-GSignondDictionary.synopsis"></a><h2>Synopsis</h2>
  37 <pre class="synopsis">
  38 #include &lt;gsignond/gsignond-dictionary.h&gt;
  39
  40 typedef             <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary">GSignondDictionary</a>;
  41 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-copy" title="gsignond_dictionary_copy ()">gsignond_dictionary_copy</a>           (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *other</code></em>);
  42 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get" title="gsignond_dictionary_get ()">gsignond_dictionary_get</a>             (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  43                                                          <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>);
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-boolean" title="gsignond_dictionary_get_boolean ()">gsignond_dictionary_get_boolean</a>     (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  45                                                          <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>,
  46                                                          <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>);
  47 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int32" title="gsignond_dictionary_get_int32 ()">gsignond_dictionary_get_int32</a>       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  48                                                          <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>,
  49                                                          <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>);
  50 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-int64" title="gsignond_dictionary_get_int64 ()">gsignond_dictionary_get_int64</a>       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  51                                                          <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>,
  52                                                          <em class="parameter"><code><span class="type">gint64</span> *value</code></em>);
  53 const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-string" title="gsignond_dictionary_get_string ()">gsignond_dictionary_get_string</a>      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  54                                                          <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>);
  55 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint32" title="gsignond_dictionary_get_uint32 ()">gsignond_dictionary_get_uint32</a>      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  56                                                          <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>,
  57                                                          <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>);
  58 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-get-uint64" title="gsignond_dictionary_get_uint64 ()">gsignond_dictionary_get_uint64</a>      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  59                                                          <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>,
  60                                                          <em class="parameter"><code><span class="type">guint64</span> *value</code></em>);
  61 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new" title="gsignond_dictionary_new ()">gsignond_dictionary_new</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
  62 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-new-from-variant" title="gsignond_dictionary_new_from_variant ()">gsignond_dictionary_new_from_variant</a>
  63                                                         (<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>);
  64 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-ref" title="gsignond_dictionary_ref ()">gsignond_dictionary_ref</a>            (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);
  65 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-remove" title="gsignond_dictionary_remove ()">gsignond_dictionary_remove</a>          (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  66                                                          <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>);
  67 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set" title="gsignond_dictionary_set ()">gsignond_dictionary_set</a>             (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  68                                                          <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>,
  69                                                          <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>);
  70 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-boolean" title="gsignond_dictionary_set_boolean ()">gsignond_dictionary_set_boolean</a>     (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  71                                                          <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>,
  72                                                          <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>);
  73 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int32" title="gsignond_dictionary_set_int32 ()">gsignond_dictionary_set_int32</a>       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  74                                                          <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>,
  75                                                          <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>);
  76 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-int64" title="gsignond_dictionary_set_int64 ()">gsignond_dictionary_set_int64</a>       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  77                                                          <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>,
  78                                                          <em class="parameter"><code><span class="type">gint64</span> value</code></em>);
  79 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-string" title="gsignond_dictionary_set_string ()">gsignond_dictionary_set_string</a>      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  80                                                          <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>,
  81                                                          <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>);
  82 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint32" title="gsignond_dictionary_set_uint32 ()">gsignond_dictionary_set_uint32</a>      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  83                                                          <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>,
  84                                                          <em class="parameter"><code><span class="type">guint32</span> value</code></em>);
  85 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set-uint64" title="gsignond_dictionary_set_uint64 ()">gsignond_dictionary_set_uint64</a>      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
  86                                                          <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>,
  87                                                          <em class="parameter"><code><span class="type">guint64</span> value</code></em>);
  88 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-to-variant" title="gsignond_dictionary_to_variant ()">gsignond_dictionary_to_variant</a>      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);
  89 <span class="returnvalue">void</span>                <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-unref" title="gsignond_dictionary_unref ()">gsignond_dictionary_unref</a>           (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);
  90 </pre>
  91 </div>
  92 <div class="refsect1">
  93 <a name="gsignond-GSignondDictionary.description"></a><h2>Description</h2>
  94 <p>
  95 A <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> 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.
  96 It's used in multiple places in gsignond and its public API to pass key-value
  97 data sets.
  98 </p>
  99 <p>
 100 </p>
 101 <div class="informalexample">
 102   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 103     <tbody>
 104       <tr>
 105         <td class="listing_lines" align="right"><pre>1
 106 2
 107 3
 108 4
 109 5
 110 6
 111 7
 112 8</pre></td>
 113         <td class="listing_code"><pre class="programlisting">GSignondDictionary* dict = gsignond_dictionary_new();
 114     gsignond_dictionary_set_string(dict, <span class="number">&quot;name&quot;</span>, <span class="number">&quot;John Smith&quot;</span>);
 115     gsignond_dictionary_set_uint32(dict, <span class="number">&quot;age&quot;</span>, <span class="number">32</span>);
 116
 117     guint32 age;
 118     gboolean success = gsignond_dictionary_get_uint32(dict, <span class="number">&quot;age&quot;</span>, &amp;age);
 119     <span class="type">const</span> gchar* name = gsignond_dictionary_get_string(dict, <span class="number">&quot;name&quot;</span>);
 120     gsignond_dictionary_unref(dict);</pre></td>
 121       </tr>
 122     </tbody>
 123   </table>
 124 </div>
 125
 126 <p>
 127 </p>
 128 </div>
 129 <div class="refsect1">
 130 <a name="gsignond-GSignondDictionary.details"></a><h2>Details</h2>
 131 <div class="refsect2">
 132 <a name="GSignondDictionary"></a><h3>GSignondDictionary</h3>
 133 <pre class="programlisting">typedef GHashTable GSignondDictionary;
 134 </pre>
 135 <p>
 136 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> is a typedef for <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>, which
 137 means the developers may also use methods associated with that structure.
 138 </p>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="gsignond-dictionary-copy"></a><h3>gsignond_dictionary_copy ()</h3>
 143 <pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_copy           (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *other</code></em>);</pre>
 144 <p>
 145 Creates a copy of the dictionary.
 146 </p>
 147 <div class="variablelist"><table border="0">
 148 <col align="left" valign="top">
 149 <tbody>
 150 <tr>
 151 <td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
 152 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 153 </td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 157 <td>
 158 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> object if the copy was successful,
 159 NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 160 </td>
 161 </tr>
 162 </tbody>
 163 </table></div>
 164 </div>
 165 <hr>
 166 <div class="refsect2">
 167 <a name="gsignond-dictionary-get"></a><h3>gsignond_dictionary_get ()</h3>
 168 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          gsignond_dictionary_get             (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 169                                                          <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>
 170 <p>
 171 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
 172 a value of an arbitrary type, and then convert it manually to a specific type
 173 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
 174 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>
 175 and similar).
 176 </p>
 177 <div class="variablelist"><table border="0">
 178 <col align="left" valign="top">
 179 <tbody>
 180 <tr>
 181 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 182 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 183 </td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 187 <td>the key to look up in the dictionary</td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 191 <td>the value; NULL is returned in case of failure (for
 192 example if the entry corresponding to the supplied key doesn't exist). <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 193 </td>
 194 </tr>
 195 </tbody>
 196 </table></div>
 197 </div>
 198 <hr>
 199 <div class="refsect2">
 200 <a name="gsignond-dictionary-get-boolean"></a><h3>gsignond_dictionary_get_boolean ()</h3>
 201 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_get_boolean     (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 202                                                          <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>,
 203                                                          <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>
 204 <p>
 205 Retrieves a gboolean value.
 206 </p>
 207 <div class="variablelist"><table border="0">
 208 <col align="left" valign="top">
 209 <tbody>
 210 <tr>
 211 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 212 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 213 </td>
 214 </tr>
 215 <tr>
 216 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 217 <td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 218 </td>
 219 </tr>
 220 <tr>
 221 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 222 <td>points to the location where the value should be set</td>
 223 </tr>
 224 <tr>
 225 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 226 <td>TRUE if the value was retrieved successfully, FALSE otherwise.</td>
 227 </tr>
 228 </tbody>
 229 </table></div>
 230 </div>
 231 <hr>
 232 <div class="refsect2">
 233 <a name="gsignond-dictionary-get-int32"></a><h3>gsignond_dictionary_get_int32 ()</h3>
 234 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_get_int32       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 235                                                          <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>,
 236                                                          <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>
 237 <p>
 238 Retrieves a int32 value.
 239 </p>
 240 <div class="variablelist"><table border="0">
 241 <col align="left" valign="top">
 242 <tbody>
 243 <tr>
 244 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 245 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 246 </td>
 247 </tr>
 248 <tr>
 249 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 250 <td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 251 </td>
 252 </tr>
 253 <tr>
 254 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 255 <td>points to the location where the value should be set</td>
 256 </tr>
 257 <tr>
 258 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 259 <td>TRUE if the value was retrieved successfully, FALSE otherwise.</td>
 260 </tr>
 261 </tbody>
 262 </table></div>
 263 </div>
 264 <hr>
 265 <div class="refsect2">
 266 <a name="gsignond-dictionary-get-int64"></a><h3>gsignond_dictionary_get_int64 ()</h3>
 267 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_get_int64       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 268                                                          <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>,
 269                                                          <em class="parameter"><code><span class="type">gint64</span> *value</code></em>);</pre>
 270 <p>
 271 Retrieves a int64 value.
 272 </p>
 273 <div class="variablelist"><table border="0">
 274 <col align="left" valign="top">
 275 <tbody>
 276 <tr>
 277 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 278 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 279 </td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 283 <td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 284 </td>
 285 </tr>
 286 <tr>
 287 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 288 <td>points to the location where the value should be set</td>
 289 </tr>
 290 <tr>
 291 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 292 <td>TRUE if the value was retrieved successfully, FALSE otherwise.</td>
 293 </tr>
 294 </tbody>
 295 </table></div>
 296 </div>
 297 <hr>
 298 <div class="refsect2">
 299 <a name="gsignond-dictionary-get-string"></a><h3>gsignond_dictionary_get_string ()</h3>
 300 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gsignond_dictionary_get_string      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 301                                                          <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>
 302 <p>
 303 Retrieves a string value.
 304 </p>
 305 <div class="variablelist"><table border="0">
 306 <col align="left" valign="top">
 307 <tbody>
 308 <tr>
 309 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 310 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 311 </td>
 312 </tr>
 313 <tr>
 314 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 315 <td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 316 </td>
 317 </tr>
 318 <tr>
 319 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 320 <td>the value if it was retrieved successfully, NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 321 </td>
 322 </tr>
 323 </tbody>
 324 </table></div>
 325 </div>
 326 <hr>
 327 <div class="refsect2">
 328 <a name="gsignond-dictionary-get-uint32"></a><h3>gsignond_dictionary_get_uint32 ()</h3>
 329 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_get_uint32      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 330                                                          <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>,
 331                                                          <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>
 332 <p>
 333 Retrieves a uint32 value.
 334 </p>
 335 <div class="variablelist"><table border="0">
 336 <col align="left" valign="top">
 337 <tbody>
 338 <tr>
 339 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 340 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 341 </td>
 342 </tr>
 343 <tr>
 344 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 345 <td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 346 </td>
 347 </tr>
 348 <tr>
 349 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 350 <td>points to the location where the value should be set</td>
 351 </tr>
 352 <tr>
 353 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 354 <td>TRUE if the value was retrieved successfully, FALSE otherwise.</td>
 355 </tr>
 356 </tbody>
 357 </table></div>
 358 </div>
 359 <hr>
 360 <div class="refsect2">
 361 <a name="gsignond-dictionary-get-uint64"></a><h3>gsignond_dictionary_get_uint64 ()</h3>
 362 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_get_uint64      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 363                                                          <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>,
 364                                                          <em class="parameter"><code><span class="type">guint64</span> *value</code></em>);</pre>
 365 <p>
 366 Retrieves a uint64 value.
 367 </p>
 368 <div class="variablelist"><table border="0">
 369 <col align="left" valign="top">
 370 <tbody>
 371 <tr>
 372 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 373 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 374 </td>
 375 </tr>
 376 <tr>
 377 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 378 <td>key to look up. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 379 </td>
 380 </tr>
 381 <tr>
 382 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 383 <td>points to the location where the value should be set</td>
 384 </tr>
 385 <tr>
 386 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 387 <td>TRUE if the value was retrieved successfully, FALSE otherwise.</td>
 388 </tr>
 389 </tbody>
 390 </table></div>
 391 </div>
 392 <hr>
 393 <div class="refsect2">
 394 <a name="gsignond-dictionary-new"></a><h3>gsignond_dictionary_new ()</h3>
 395 <pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_new            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 396 <p>
 397 Creates a new instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>.
 398 </p>
 399 <div class="variablelist"><table border="0">
 400 <col align="left" valign="top">
 401 <tbody><tr>
 402 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 403 <td>
 404 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> object if successful,
 405 NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 406 </td>
 407 </tr></tbody>
 408 </table></div>
 409 </div>
 410 <hr>
 411 <div class="refsect2">
 412 <a name="gsignond-dictionary-new-from-variant"></a><h3>gsignond_dictionary_new_from_variant ()</h3>
 413 <pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_new_from_variant
 414                                                         (<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>
 415 <p>
 416 Converts the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>. This is useful for example if
 417 the dictionary needs to be deserialized, or if it's contained in another
 418 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> 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>.
 419 </p>
 420 <div class="variablelist"><table border="0">
 421 <col align="left" valign="top">
 422 <tbody>
 423 <tr>
 424 <td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
 425 <td>instance of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>
 426 </td>
 427 </tr>
 428 <tr>
 429 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 430 <td>
 431 <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> if successful, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 432 </td>
 433 </tr>
 434 </tbody>
 435 </table></div>
 436 </div>
 437 <hr>
 438 <div class="refsect2">
 439 <a name="gsignond-dictionary-ref"></a><h3>gsignond_dictionary_ref ()</h3>
 440 <pre class="programlisting"><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="returnvalue">GSignondDictionary</span></a> * gsignond_dictionary_ref            (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);</pre>
 441 <p>
 442 Increments the reference count of the dictionary structure.
 443 </p>
 444 <div class="variablelist"><table border="0">
 445 <col align="left" valign="top">
 446 <tbody>
 447 <tr>
 448 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 449 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 450 </td>
 451 </tr>
 452 <tr>
 453 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 454 <td>the pointer to the passed in <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 455 </td>
 456 </tr>
 457 </tbody>
 458 </table></div>
 459 </div>
 460 <hr>
 461 <div class="refsect2">
 462 <a name="gsignond-dictionary-remove"></a><h3>gsignond_dictionary_remove ()</h3>
 463 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_remove          (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 464                                                          <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>
 465 <p>
 466 Removes key-value pair in the dictionary as per key.
 467 </p>
 468 <div class="variablelist"><table border="0">
 469 <col align="left" valign="top">
 470 <tbody>
 471 <tr>
 472 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 473 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 474 </td>
 475 </tr>
 476 <tr>
 477 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 478 <td>key which needs to be removed from the dictionary. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 479 </td>
 480 </tr>
 481 <tr>
 482 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 483 <td>TRUE if successful, FALSE otherwise.</td>
 484 </tr>
 485 </tbody>
 486 </table></div>
 487 </div>
 488 <hr>
 489 <div class="refsect2">
 490 <a name="gsignond-dictionary-set"></a><h3>gsignond_dictionary_set ()</h3>
 491 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_set             (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 492                                                          <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>,
 493                                                          <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>
 494 <p>
 495 Adds or replaces key-value pair in the dictionary. This allows to set a value
 496 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
 497 commonly used types also type-specific setters are provided.
 498 </p>
 499 <div class="variablelist"><table border="0">
 500 <col align="left" valign="top">
 501 <tbody>
 502 <tr>
 503 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 504 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 505 </td>
 506 </tr>
 507 <tr>
 508 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 509 <td>key to be set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 510 </td>
 511 </tr>
 512 <tr>
 513 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 514 <td>value to be set. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 515 </td>
 516 </tr>
 517 <tr>
 518 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 519 <td>TRUE if successful, FALSE otherwise.</td>
 520 </tr>
 521 </tbody>
 522 </table></div>
 523 </div>
 524 <hr>
 525 <div class="refsect2">
 526 <a name="gsignond-dictionary-set-boolean"></a><h3>gsignond_dictionary_set_boolean ()</h3>
 527 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_set_boolean     (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 528                                                          <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>,
 529                                                          <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>
 530 <p>
 531 Sets or replaces a gboolean value in the dictionary.
 532 </p>
 533 <div class="variablelist"><table border="0">
 534 <col align="left" valign="top">
 535 <tbody>
 536 <tr>
 537 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 538 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 539 </td>
 540 </tr>
 541 <tr>
 542 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 543 <td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 544 </td>
 545 </tr>
 546 <tr>
 547 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 548 <td>value to set</td>
 549 </tr>
 550 <tr>
 551 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 552 <td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td>
 553 </tr>
 554 </tbody>
 555 </table></div>
 556 </div>
 557 <hr>
 558 <div class="refsect2">
 559 <a name="gsignond-dictionary-set-int32"></a><h3>gsignond_dictionary_set_int32 ()</h3>
 560 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_set_int32       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 561                                                          <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>,
 562                                                          <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>
 563 <p>
 564 Sets or replaces a int32 value in the dictionary.
 565 </p>
 566 <div class="variablelist"><table border="0">
 567 <col align="left" valign="top">
 568 <tbody>
 569 <tr>
 570 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 571 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 572 </td>
 573 </tr>
 574 <tr>
 575 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 576 <td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 577 </td>
 578 </tr>
 579 <tr>
 580 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 581 <td>value to set</td>
 582 </tr>
 583 <tr>
 584 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 585 <td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td>
 586 </tr>
 587 </tbody>
 588 </table></div>
 589 </div>
 590 <hr>
 591 <div class="refsect2">
 592 <a name="gsignond-dictionary-set-int64"></a><h3>gsignond_dictionary_set_int64 ()</h3>
 593 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_set_int64       (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 594                                                          <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>,
 595                                                          <em class="parameter"><code><span class="type">gint64</span> value</code></em>);</pre>
 596 <p>
 597 Sets or replaces a int64 value in the dictionary.
 598 </p>
 599 <div class="variablelist"><table border="0">
 600 <col align="left" valign="top">
 601 <tbody>
 602 <tr>
 603 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 604 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 605 </td>
 606 </tr>
 607 <tr>
 608 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 609 <td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 610 </td>
 611 </tr>
 612 <tr>
 613 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 614 <td>value to set</td>
 615 </tr>
 616 <tr>
 617 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 618 <td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td>
 619 </tr>
 620 </tbody>
 621 </table></div>
 622 </div>
 623 <hr>
 624 <div class="refsect2">
 625 <a name="gsignond-dictionary-set-string"></a><h3>gsignond_dictionary_set_string ()</h3>
 626 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_set_string      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 627                                                          <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>,
 628                                                          <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>
 629 <p>
 630 Sets or replaces a string value in the dictionary.
 631 </p>
 632 <div class="variablelist"><table border="0">
 633 <col align="left" valign="top">
 634 <tbody>
 635 <tr>
 636 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 637 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 638 </td>
 639 </tr>
 640 <tr>
 641 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 642 <td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 643 </td>
 644 </tr>
 645 <tr>
 646 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 647 <td>value to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 648 </td>
 649 </tr>
 650 <tr>
 651 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 652 <td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td>
 653 </tr>
 654 </tbody>
 655 </table></div>
 656 </div>
 657 <hr>
 658 <div class="refsect2">
 659 <a name="gsignond-dictionary-set-uint32"></a><h3>gsignond_dictionary_set_uint32 ()</h3>
 660 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_set_uint32      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 661                                                          <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>,
 662                                                          <em class="parameter"><code><span class="type">guint32</span> value</code></em>);</pre>
 663 <p>
 664 Sets or replaces a uint32 value in the dictionary.
 665 </p>
 666 <div class="variablelist"><table border="0">
 667 <col align="left" valign="top">
 668 <tbody>
 669 <tr>
 670 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 671 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 672 </td>
 673 </tr>
 674 <tr>
 675 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 676 <td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 677 </td>
 678 </tr>
 679 <tr>
 680 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 681 <td>value to set</td>
 682 </tr>
 683 <tr>
 684 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 685 <td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td>
 686 </tr>
 687 </tbody>
 688 </table></div>
 689 </div>
 690 <hr>
 691 <div class="refsect2">
 692 <a name="gsignond-dictionary-set-uint64"></a><h3>gsignond_dictionary_set_uint64 ()</h3>
 693 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsignond_dictionary_set_uint64      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>,
 694                                                          <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>,
 695                                                          <em class="parameter"><code><span class="type">guint64</span> value</code></em>);</pre>
 696 <p>
 697 Sets or replaces a uint64 value in the dictionary.
 698 </p>
 699 <div class="variablelist"><table border="0">
 700 <col align="left" valign="top">
 701 <tbody>
 702 <tr>
 703 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 704 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 705 </td>
 706 </tr>
 707 <tr>
 708 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 709 <td>key to set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 710 </td>
 711 </tr>
 712 <tr>
 713 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 714 <td>value to set</td>
 715 </tr>
 716 <tr>
 717 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 718 <td>TRUE if the value was set or replaced successfully, FALSE otherwise.</td>
 719 </tr>
 720 </tbody>
 721 </table></div>
 722 </div>
 723 <hr>
 724 <div class="refsect2">
 725 <a name="gsignond-dictionary-to-variant"></a><h3>gsignond_dictionary_to_variant ()</h3>
 726 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          gsignond_dictionary_to_variant      (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);</pre>
 727 <p>
 728 Converts the <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> 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
 729 or put into another <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> using <a class="link" href="gsignond-GSignondDictionary.html#gsignond-dictionary-set" title="gsignond_dictionary_set ()"><code class="function">gsignond_dictionary_set()</code></a>.
 730 </p>
 731 <div class="variablelist"><table border="0">
 732 <col align="left" valign="top">
 733 <tbody>
 734 <tr>
 735 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 736 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 737 </td>
 738 </tr>
 739 <tr>
 740 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 741 <td>
 742 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> object if successful, NULL otherwise. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 743 </td>
 744 </tr>
 745 </tbody>
 746 </table></div>
 747 </div>
 748 <hr>
 749 <div class="refsect2">
 750 <a name="gsignond-dictionary-unref"></a><h3>gsignond_dictionary_unref ()</h3>
 751 <pre class="programlisting"><span class="returnvalue">void</span>                gsignond_dictionary_unref           (<em class="parameter"><code><a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a> *dict</code></em>);</pre>
 752 <p>
 753 Decrements the reference count of the dictionary structure. If the reference
 754 count reaches zero, the structure is deallocated and shouldn't be used.
 755 </p>
 756 <div class="variablelist"><table border="0">
 757 <col align="left" valign="top">
 758 <tbody><tr>
 759 <td><p><span class="term"><em class="parameter"><code>dict</code></em> :</span></p></td>
 760 <td>instance of <a class="link" href="gsignond-GSignondDictionary.html#GSignondDictionary" title="GSignondDictionary"><span class="type">GSignondDictionary</span></a>
 761 </td>
 762 </tr></tbody>
 763 </table></div>
 764 </div>
 765 </div>
 766 </div>
 767 <div class="footer">
 768 <hr>
 769           Generated by GTK-Doc V1.19.1</div>
 770 </body>
 771 </html>