docs/html/TlmConfig.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>TlmConfig</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="Tizen Login Manager Reference Manual">
   8 <link rel="up" href="ch01.html" title="Introduction">
   9 <link rel="prev" href="tlm-intro.html" title="Introduction">
  10 <link rel="next" href="tlm-General-configuration.html" title="General configuration">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="tlm-intro.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">Tizen Login Manager Reference Manual</th>
  21 <td><a accesskey="n" href="tlm-General-configuration.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#TlmConfig.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#TlmConfig.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#TlmConfig.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="TlmConfig"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="TlmConfig.top_of_page"></a>TlmConfig</span></h2>
  36 <p>TlmConfig — tlm configuration information</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="TlmConfig.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">
  43 #include &lt;tlm-config.h&gt;
  44
  45 struct              <a class="link" href="TlmConfig.html#TlmConfig-struct" title="struct TlmConfig">TlmConfig</a>;
  46 struct              <a class="link" href="TlmConfig.html#TlmConfigClass" title="struct TlmConfigClass">TlmConfigClass</a>;
  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="TlmConfig.html#tlm-config-get-boolean" title="tlm_config_get_boolean ()">tlm_config_get_boolean</a>              (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</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> *group</code></em>,
  49                                                          <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>,
  50                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> retval</code></em>);
  51 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <a class="link" href="TlmConfig.html#tlm-config-get-group" title="tlm_config_get_group ()">tlm_config_get_group</a>                (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  52                                                          <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> *group</code></em>);
  53 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="TlmConfig.html#tlm-config-get-int" title="tlm_config_get_int ()">tlm_config_get_int</a>                  (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</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> *group</code></em>,
  55                                                          <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>,
  56                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> retval</code></em>);
  57 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="TlmConfig.html#tlm-config-get-string" title="tlm_config_get_string ()">tlm_config_get_string</a>               (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  58                                                          <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> *group</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 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="TlmConfig.html#tlm-config-get-uint" title="tlm_config_get_uint ()">tlm_config_get_uint</a>                 (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  61                                                          <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> *group</code></em>,
  62                                                          <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>,
  63                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> retval</code></em>);
  64 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="TlmConfig.html#tlm-config-has-group" title="tlm_config_has_group ()">tlm_config_has_group</a>                (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  65                                                          <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> *group</code></em>);
  66 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="TlmConfig.html#tlm-config-has-key" title="tlm_config_has_key ()">tlm_config_has_key</a>                  (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  67                                                          <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> *group</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 <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="returnvalue">TlmConfig</span></a> *         <a class="link" href="TlmConfig.html#tlm-config-new" title="tlm_config_new ()">tlm_config_new</a>                      ();
  70 <span class="returnvalue">void</span>                <a class="link" href="TlmConfig.html#tlm-config-reload" title="tlm_config_reload ()">tlm_config_reload</a>                   (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>);
  71 <span class="returnvalue">void</span>                <a class="link" href="TlmConfig.html#tlm-config-set-boolean" title="tlm_config_set_boolean ()">tlm_config_set_boolean</a>              (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  72                                                          <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> *group</code></em>,
  73                                                          <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>,
  74                                                          <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>);
  75 <span class="returnvalue">void</span>                <a class="link" href="TlmConfig.html#tlm-config-set-int" title="tlm_config_set_int ()">tlm_config_set_int</a>                  (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  76                                                          <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> *group</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><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);
  79 <span class="returnvalue">void</span>                <a class="link" href="TlmConfig.html#tlm-config-set-string" title="tlm_config_set_string ()">tlm_config_set_string</a>               (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</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> *group</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> *key</code></em>,
  82                                                          <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>);
  83 <span class="returnvalue">void</span>                <a class="link" href="TlmConfig.html#tlm-config-set-uint" title="tlm_config_set_uint ()">tlm_config_set_uint</a>                 (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
  84                                                          <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> *group</code></em>,
  85                                                          <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>,
  86                                                          <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>);
  87 </pre>
  88 </div>
  89 <div class="refsect1">
  90 <a name="TlmConfig.object-hierarchy"></a><h2>Object Hierarchy</h2>
  91 <pre class="synopsis">
  92   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  93    +----TlmConfig
  94 </pre>
  95 </div>
  96 <div class="refsect1">
  97 <a name="TlmConfig.description"></a><h2>Description</h2>
  98 <p>
  99 <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> holds configuration information as a set of keys and values
 100 (integer or strings). The key names are defined in
 101 <a class="link" href="tlm-General-configuration.html" title="General configuration">General config keys</a>.
 102 Note that authentication and account plugins may use plugin-specific
 103 configuration keys; see plugins' documentation for specifics.
 104 </p>
 105 <p>
 106 The configuration is retrieved from the tlm configuration file. See below
 107 for where the file is searched for.
 108 </p>
 109 <p>
 110 </p>
 111 <div class="refsect1">
 112 <a name="idp10014048"></a><h2>Usage</h2>
 113 </div>
 114 <p>
 115 Following code snippet demonstrates how to create and use config object:
 116 </p>
 117 <div class="informalexample"><pre class="programlisting">
 118
 119 TlmConfig* config = tlm_config_new ();
 120 const gchar *str = tlm_config_get_string (config,
 121  TLM_CONFIG_GENERAL, TLM_CONFIG_GENERAL_PAM_SERVICE, 0);
 122 g_object_unref(config);
 123
 124 </pre></div>
 125 <p>
 126 </p>
 127 <p>
 128 </p>
 129 <div class="refsect1">
 130 <a name="idp7277520"></a><h2>Where the configuration file is searched for</h2>
 131 </div>
 132 <p>
 133 </p>
 134 <p>
 135 If tlm has been compiled with --enable-debug, then these locations are used,
 136 in decreasing order of priority:
 137 </p>
 138 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 139 <li class="listitem"><p>TLM_CONF_FILE environment variable</p></li>
 140 <li class="listitem"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-get-user-config-dir"><code class="function">g_get_user_config_dir()</code></a> + "tlm.conf"</p></li>
 141 <li class="listitem"><p>each of <a href="http://library.gnome.org/devel/glib/unstable/glib-Miscellaneous-Utility-Functions.html#g-get-system-config-dirs"><code class="function">g_get_system_config_dirs()</code></a> + "tlm.conf"</p></li>
 142 </ul></div>
 143 <p>
 144 </p>
 145 <p>
 146 Otherwise, the config file location is determined at compilation time as
 147 $(sysconfdir) + "tlm.conf"
 148 </p>
 149 <p>
 150 </p>
 151 <div class="refsect1">
 152 <a name="idp10633040"></a><h2>Example configuration file</h2>
 153 </div>
 154 <p>
 155 </p>
 156 <p>
 157 See example configuration file here:
 158 <a class="ulink" href="https://github.com/01org/tlm/blob/master/data/tlm.conf.in" target="_top">
 159 tlm configuration file</a>
 160 </p>
 161 </div>
 162 <div class="refsect1">
 163 <a name="TlmConfig.details"></a><h2>Details</h2>
 164 <div class="refsect2">
 165 <a name="TlmConfig-struct"></a><h3>struct TlmConfig</h3>
 166 <pre class="programlisting">struct TlmConfig;</pre>
 167 <p>
 168 Opaque structure for the object.
 169 </p>
 170 </div>
 171 <hr>
 172 <div class="refsect2">
 173 <a name="TlmConfigClass"></a><h3>struct TlmConfigClass</h3>
 174 <pre class="programlisting">struct TlmConfigClass {
 175     GObjectClass parent_class;
 176 };
 177 </pre>
 178 <p>
 179 Opaque structure for the class.
 180 </p>
 181 <div class="variablelist"><table border="0">
 182 <col align="left" valign="top">
 183 <tbody><tr>
 184 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="TlmConfigClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 185 <td>parent class object</td>
 186 </tr></tbody>
 187 </table></div>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="tlm-config-get-boolean"></a><h3>tlm_config_get_boolean ()</h3>
 192 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tlm_config_get_boolean              (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 193                                                          <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> *group</code></em>,
 194                                                          <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>,
 195                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> retval</code></em>);</pre>
 196 <p>
 197 Get a boolean configuration value.
 198 </p>
 199 <div class="variablelist"><table border="0">
 200 <col align="left" valign="top">
 201 <tbody>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 204 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 205 </td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 209 <td>the group name. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 210 </td>
 211 </tr>
 212 <tr>
 213 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 214 <td>the key name. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 215 </td>
 216 </tr>
 217 <tr>
 218 <td><p><span class="term"><em class="parameter"><code>retval</code></em> :</span></p></td>
 219 <td>value to be returned in case key is not found</td>
 220 </tr>
 221 <tr>
 222 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 223 <td>the value corresponding to the key as boolean. If the
 224 key does not exist or cannot be converted to boolean, retval is returned.</td>
 225 </tr>
 226 </tbody>
 227 </table></div>
 228 </div>
 229 <hr>
 230 <div class="refsect2">
 231 <a name="tlm-config-get-group"></a><h3>tlm_config_get_group ()</h3>
 232 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        tlm_config_get_group                (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 233                                                          <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> *group</code></em>);</pre>
 234 <p>
 235 Retrives the configuration in given <span class="type">group</span> as <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>
 236 </p>
 237 <div class="variablelist"><table border="0">
 238 <col align="left" valign="top">
 239 <tbody>
 240 <tr>
 241 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 242 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 243 </td>
 244 </tr>
 245 <tr>
 246 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 247 <td>the group name</td>
 248 </tr>
 249 <tr>
 250 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 251 <td>the key, value paired dictionary if found,
 252 NULL otherwise. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 253 </td>
 254 </tr>
 255 </tbody>
 256 </table></div>
 257 </div>
 258 <hr>
 259 <div class="refsect2">
 260 <a name="tlm-config-get-int"></a><h3>tlm_config_get_int ()</h3>
 261 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                tlm_config_get_int                  (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 262                                                          <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> *group</code></em>,
 263                                                          <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>,
 264                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> retval</code></em>);</pre>
 265 <p>
 266 Get an integer configuration value.
 267 </p>
 268 <div class="variablelist"><table border="0">
 269 <col align="left" valign="top">
 270 <tbody>
 271 <tr>
 272 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 273 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 274 </td>
 275 </tr>
 276 <tr>
 277 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 278 <td>the group name</td>
 279 </tr>
 280 <tr>
 281 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 282 <td>the key name</td>
 283 </tr>
 284 <tr>
 285 <td><p><span class="term"><em class="parameter"><code>retval</code></em> :</span></p></td>
 286 <td>value to be returned in case key is not found</td>
 287 </tr>
 288 <tr>
 289 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 290 <td>the value corresponding to the key as an integer. If the key does
 291 not exist or cannot be converted to the integer, retval is returned.</td>
 292 </tr>
 293 </tbody>
 294 </table></div>
 295 </div>
 296 <hr>
 297 <div class="refsect2">
 298 <a name="tlm-config-get-string"></a><h3>tlm_config_get_string ()</h3>
 299 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       tlm_config_get_string               (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 300                                                          <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> *group</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 Get a string configuration 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>self</code></em> :</span></p></td>
 310 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 311 </td>
 312 </tr>
 313 <tr>
 314 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 315 <td>the group name, NULL refers to General. <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"><em class="parameter"><code>key</code></em> :</span></p></td>
 320 <td>the key name. <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 <tr>
 324 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 325 <td>the value corresponding to the key as an string. If the
 326 key does not exist or cannot be converted to the integer, NULL is returned.</td>
 327 </tr>
 328 </tbody>
 329 </table></div>
 330 </div>
 331 <hr>
 332 <div class="refsect2">
 333 <a name="tlm-config-get-uint"></a><h3>tlm_config_get_uint ()</h3>
 334 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               tlm_config_get_uint                 (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 335                                                          <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> *group</code></em>,
 336                                                          <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>,
 337                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> retval</code></em>);</pre>
 338 <p>
 339 Get an unsigned integer configuration value.
 340 </p>
 341 <div class="variablelist"><table border="0">
 342 <col align="left" valign="top">
 343 <tbody>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 346 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 347 </td>
 348 </tr>
 349 <tr>
 350 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 351 <td>the group name. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 352 </td>
 353 </tr>
 354 <tr>
 355 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 356 <td>the key name. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 357 </td>
 358 </tr>
 359 <tr>
 360 <td><p><span class="term"><em class="parameter"><code>retval</code></em> :</span></p></td>
 361 <td>value to be returned in case key is not found</td>
 362 </tr>
 363 <tr>
 364 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 365 <td>the value corresponding to the key as an unsigned integer. If the
 366 key does not exist or cannot be converted to the integer, retval is returned.</td>
 367 </tr>
 368 </tbody>
 369 </table></div>
 370 </div>
 371 <hr>
 372 <div class="refsect2">
 373 <a name="tlm-config-has-group"></a><h3>tlm_config_has_group ()</h3>
 374 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tlm_config_has_group                (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 375                                                          <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> *group</code></em>);</pre>
 376 <p>
 377 Checks if any configuration available for <span class="type">group</span>.
 378 </p>
 379 <div class="variablelist"><table border="0">
 380 <col align="left" valign="top">
 381 <tbody>
 382 <tr>
 383 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 384 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 385 </td>
 386 </tr>
 387 <tr>
 388 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 389 <td>the group name</td>
 390 </tr>
 391 <tr>
 392 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 393 <td>TRUE if found, FALSE otherwise.</td>
 394 </tr>
 395 </tbody>
 396 </table></div>
 397 </div>
 398 <hr>
 399 <div class="refsect2">
 400 <a name="tlm-config-has-key"></a><h3>tlm_config_has_key ()</h3>
 401 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            tlm_config_has_key                  (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 402                                                          <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> *group</code></em>,
 403                                                          <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>
 404 <p>
 405 Checks if <span class="type">key</span> is in given <span class="type">group</span>.
 406 </p>
 407 <div class="variablelist"><table border="0">
 408 <col align="left" valign="top">
 409 <tbody>
 410 <tr>
 411 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 412 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 413 </td>
 414 </tr>
 415 <tr>
 416 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 417 <td>the group name</td>
 418 </tr>
 419 <tr>
 420 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 421 <td>the key name</td>
 422 </tr>
 423 <tr>
 424 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 425 <td>TRUE, if found, FALSE otherwise.</td>
 426 </tr>
 427 </tbody>
 428 </table></div>
 429 </div>
 430 <hr>
 431 <div class="refsect2">
 432 <a name="tlm-config-new"></a><h3>tlm_config_new ()</h3>
 433 <pre class="programlisting"><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="returnvalue">TlmConfig</span></a> *         tlm_config_new                      ();</pre>
 434 <p>
 435 Create a <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> object.
 436 </p>
 437 <div class="variablelist"><table border="0">
 438 <col align="left" valign="top">
 439 <tbody><tr>
 440 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 441 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>.</td>
 442 </tr></tbody>
 443 </table></div>
 444 </div>
 445 <hr>
 446 <div class="refsect2">
 447 <a name="tlm-config-reload"></a><h3>tlm_config_reload ()</h3>
 448 <pre class="programlisting"><span class="returnvalue">void</span>                tlm_config_reload                   (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>);</pre>
 449 <p>
 450 Reloads the configuration.
 451 </p>
 452 <div class="variablelist"><table border="0">
 453 <col align="left" valign="top">
 454 <tbody><tr>
 455 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 456 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 457 </td>
 458 </tr></tbody>
 459 </table></div>
 460 </div>
 461 <hr>
 462 <div class="refsect2">
 463 <a name="tlm-config-set-boolean"></a><h3>tlm_config_set_boolean ()</h3>
 464 <pre class="programlisting"><span class="returnvalue">void</span>                tlm_config_set_boolean              (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 465                                                          <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> *group</code></em>,
 466                                                          <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>,
 467                                                          <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>
 468 <p>
 469 Sets the configuration value to the provided <span class="type">value</span>.
 470 </p>
 471 <div class="variablelist"><table border="0">
 472 <col align="left" valign="top">
 473 <tbody>
 474 <tr>
 475 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 476 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 477 </td>
 478 </tr>
 479 <tr>
 480 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 481 <td>the group name</td>
 482 </tr>
 483 <tr>
 484 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 485 <td>the key name</td>
 486 </tr>
 487 <tr>
 488 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 489 <td>the value</td>
 490 </tr>
 491 </tbody>
 492 </table></div>
 493 </div>
 494 <hr>
 495 <div class="refsect2">
 496 <a name="tlm-config-set-int"></a><h3>tlm_config_set_int ()</h3>
 497 <pre class="programlisting"><span class="returnvalue">void</span>                tlm_config_set_int                  (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 498                                                          <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> *group</code></em>,
 499                                                          <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>,
 500                                                          <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>
 501 <p>
 502 Sets the configuration value to the provided integer.
 503 </p>
 504 <div class="variablelist"><table border="0">
 505 <col align="left" valign="top">
 506 <tbody>
 507 <tr>
 508 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 509 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <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>group</code></em> :</span></p></td>
 514 <td>the group name</td>
 515 </tr>
 516 <tr>
 517 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 518 <td>the key name</td>
 519 </tr>
 520 <tr>
 521 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 522 <td>the value</td>
 523 </tr>
 524 </tbody>
 525 </table></div>
 526 </div>
 527 <hr>
 528 <div class="refsect2">
 529 <a name="tlm-config-set-string"></a><h3>tlm_config_set_string ()</h3>
 530 <pre class="programlisting"><span class="returnvalue">void</span>                tlm_config_set_string               (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 531                                                          <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> *group</code></em>,
 532                                                          <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>,
 533                                                          <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>
 534 <p>
 535 Sets the configuration value to the provided string.
 536 </p>
 537 <div class="variablelist"><table border="0">
 538 <col align="left" valign="top">
 539 <tbody>
 540 <tr>
 541 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 542 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 543 </td>
 544 </tr>
 545 <tr>
 546 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 547 <td>the group name. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 548 </td>
 549 </tr>
 550 <tr>
 551 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 552 <td>the key name. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 553 </td>
 554 </tr>
 555 <tr>
 556 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 557 <td>the value. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 558 </td>
 559 </tr>
 560 </tbody>
 561 </table></div>
 562 </div>
 563 <hr>
 564 <div class="refsect2">
 565 <a name="tlm-config-set-uint"></a><h3>tlm_config_set_uint ()</h3>
 566 <pre class="programlisting"><span class="returnvalue">void</span>                tlm_config_set_uint                 (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 567                                                          <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> *group</code></em>,
 568                                                          <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>,
 569                                                          <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>
 570 <p>
 571 Sets the configuration value to the provided unsigned integer.
 572 </p>
 573 <div class="variablelist"><table border="0">
 574 <col align="left" valign="top">
 575 <tbody>
 576 <tr>
 577 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 578 <td>an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 579 </td>
 580 </tr>
 581 <tr>
 582 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
 583 <td>the group name. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 584 </td>
 585 </tr>
 586 <tr>
 587 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 588 <td>the key name</td>
 589 </tr>
 590 <tr>
 591 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 592 <td>the value</td>
 593 </tr>
 594 </tbody>
 595 </table></div>
 596 </div>
 597 </div>
 598 </div>
 599 <div class="footer">
 600 <hr>
 601           Generated by GTK-Doc V1.18</div>
 602 </body>
 603 </html>