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>Tizen Login Manager Reference Manual: TlmConfig</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#TlmConfig.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#TlmConfig.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="tlm-intro.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="tlm-General-configuration.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="TlmConfig"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="TlmConfig.top_of_page"></a>TlmConfig</span></h2>
  31 <p>TlmConfig — tlm configuration information</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="TlmConfig.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="returnvalue">TlmConfig</span></a> *
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="TlmConfig.html#tlm-config-new" title="tlm_config_new ()">tlm_config_new</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="TlmConfig.html#tlm-config-get-int" title="tlm_config_get_int ()">tlm_config_get_int</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <span class="returnvalue">void</span>
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="TlmConfig.html#tlm-config-set-int" title="tlm_config_set_int ()">tlm_config_set_int</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="TlmConfig.html#tlm-config-get-uint" title="tlm_config_get_uint ()">tlm_config_get_uint</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <span class="returnvalue">void</span>
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="TlmConfig.html#tlm-config-set-uint" title="tlm_config_set_uint ()">tlm_config_set_uint</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 <tr>
  84 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  85 </td>
  86 <td class="function_name">
  87 <a class="link" href="TlmConfig.html#tlm-config-get-string" title="tlm_config_get_string ()">tlm_config_get_string</a> <span class="c_punctuation">()</span>
  88 </td>
  89 </tr>
  90 <tr>
  91 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  92 </td>
  93 <td class="function_name">
  94 <a class="link" href="TlmConfig.html#tlm-config-get-string-default" title="tlm_config_get_string_default ()">tlm_config_get_string_default</a> <span class="c_punctuation">()</span>
  95 </td>
  96 </tr>
  97 <tr>
  98 <td class="function_type">
  99 <span class="returnvalue">void</span>
 100 </td>
 101 <td class="function_name">
 102 <a class="link" href="TlmConfig.html#tlm-config-set-string" title="tlm_config_set_string ()">tlm_config_set_string</a> <span class="c_punctuation">()</span>
 103 </td>
 104 </tr>
 105 <tr>
 106 <td class="function_type">
 107 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 108 </td>
 109 <td class="function_name">
 110 <a class="link" href="TlmConfig.html#tlm-config-get-boolean" title="tlm_config_get_boolean ()">tlm_config_get_boolean</a> <span class="c_punctuation">()</span>
 111 </td>
 112 </tr>
 113 <tr>
 114 <td class="function_type">
 115 <span class="returnvalue">void</span>
 116 </td>
 117 <td class="function_name">
 118 <a class="link" href="TlmConfig.html#tlm-config-set-boolean" title="tlm_config_set_boolean ()">tlm_config_set_boolean</a> <span class="c_punctuation">()</span>
 119 </td>
 120 </tr>
 121 <tr>
 122 <td class="function_type">
 123 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 124 </td>
 125 <td class="function_name">
 126 <a class="link" href="TlmConfig.html#tlm-config-has-group" title="tlm_config_has_group ()">tlm_config_has_group</a> <span class="c_punctuation">()</span>
 127 </td>
 128 </tr>
 129 <tr>
 130 <td class="function_type">
 131 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 132 </td>
 133 <td class="function_name">
 134 <a class="link" href="TlmConfig.html#tlm-config-has-key" title="tlm_config_has_key ()">tlm_config_has_key</a> <span class="c_punctuation">()</span>
 135 </td>
 136 </tr>
 137 <tr>
 138 <td class="function_type">
 139 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
 140 </td>
 141 <td class="function_name">
 142 <a class="link" href="TlmConfig.html#tlm-config-get-group" title="tlm_config_get_group ()">tlm_config_get_group</a> <span class="c_punctuation">()</span>
 143 </td>
 144 </tr>
 145 <tr>
 146 <td class="function_type">
 147 <span class="returnvalue">void</span>
 148 </td>
 149 <td class="function_name">
 150 <a class="link" href="TlmConfig.html#tlm-config-reload" title="tlm_config_reload ()">tlm_config_reload</a> <span class="c_punctuation">()</span>
 151 </td>
 152 </tr>
 153 </tbody>
 154 </table></div>
 155 </div>
 156 <div class="refsect1">
 157 <a name="TlmConfig.object-hierarchy"></a><h2>Object Hierarchy</h2>
 158 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 159     <span class="lineart">╰──</span> TlmConfig
 160 </pre>
 161 </div>
 162 <div class="refsect1">
 163 <a name="TlmConfig.includes"></a><h2>Includes</h2>
 164 <pre class="synopsis">#include &lt;tlm-config.h&gt;
 165 </pre>
 166 </div>
 167 <div class="refsect1">
 168 <a name="TlmConfig.description"></a><h2>Description</h2>
 169 <p><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> holds configuration information as a set of keys and values
 170 (integer or strings). The key names are defined in</p>
 171 <a class="link" href="tlm-General-configuration.html" title="General configuration">General config keys</a>.
 172 <p>Note that authentication and account plugins may use plugin-specific
 173 configuration keys; see plugins' documentation for specifics.</p>
 174 <p>The configuration is retrieved from the tlm configuration file. See below
 175 for where the file is searched for.</p>
 176 <div class="refsect1">
 177 <a name="id-1.2.3.6.6"></a><h2>Usage</h2>
 178 </div>
 179 <p>Following code snippet demonstrates how to create and use config object:</p>
 180 <div class="informalexample"><pre class="programlisting">
 181
 182 TlmConfig* config = tlm_config_new ();
 183 const gchar *str = tlm_config_get_string (config,
 184  TLM_CONFIG_GENERAL, TLM_CONFIG_GENERAL_PAM_SERVICE, 0);
 185 g_object_unref(config);
 186
 187 </pre></div>
 188 <p></p>
 189 <div class="refsect1">
 190 <a name="id-1.2.3.6.10"></a><h2>Where the configuration file is searched for</h2>
 191 </div>
 192 <p>If tlm has been compiled with --enable-debug, then these locations are used,
 193 in decreasing order of priority:</p>
 194 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 195 <li class="listitem"><p>TLM_CONF_FILE environment variable</p></li>
 196 <li class="listitem"><p>g_get_user_config_dir() + "tlm.conf"</p></li>
 197 <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>
 198 </ul></div>
 199 <p>Otherwise, the config file location is determined at compilation time as
 200 $(sysconfdir) + "tlm.conf"</p>
 201 <div class="refsect1">
 202 <a name="id-1.2.3.6.14"></a><h2>Example configuration file</h2>
 203 </div>
 204 <p>See example configuration file here:</p>
 205 <a class="ulink" href="https://github.com/01org/tlm/blob/master/data/tlm.conf.in" target="_top">
 206 tlm configuration file</a>
 207 </div>
 208 <div class="refsect1">
 209 <a name="TlmConfig.functions_details"></a><h2>Functions</h2>
 210 <div class="refsect2">
 211 <a name="tlm-config-new"></a><h3>tlm_config_new ()</h3>
 212 <pre class="programlisting"><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="returnvalue">TlmConfig</span></a> *
 213 tlm_config_new ();</pre>
 214 <p>Create a <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> object.</p>
 215 <div class="refsect3">
 216 <a name="id-1.2.3.7.2.5"></a><h4>Returns</h4>
 217 <p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>.</p>
 218 <p></p>
 219 </div>
 220 </div>
 221 <hr>
 222 <div class="refsect2">
 223 <a name="tlm-config-get-int"></a><h3>tlm_config_get_int ()</h3>
 224 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
 225 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>,
 226                     <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>,
 227                     <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>,
 228                     <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>
 229 <p>Get an integer configuration value.</p>
 230 <div class="refsect3">
 231 <a name="id-1.2.3.7.3.5"></a><h4>Parameters</h4>
 232 <div class="informaltable"><table width="100%" border="0">
 233 <colgroup>
 234 <col width="150px" class="parameters_name">
 235 <col class="parameters_description">
 236 <col width="200px" class="parameters_annotations">
 237 </colgroup>
 238 <tbody>
 239 <tr>
 240 <td class="parameter_name"><p>self</p></td>
 241 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 242 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 243 </tr>
 244 <tr>
 245 <td class="parameter_name"><p>group</p></td>
 246 <td class="parameter_description"><p>the group name</p></td>
 247 <td class="parameter_annotations"> </td>
 248 </tr>
 249 <tr>
 250 <td class="parameter_name"><p>key</p></td>
 251 <td class="parameter_description"><p>the key name</p></td>
 252 <td class="parameter_annotations"> </td>
 253 </tr>
 254 <tr>
 255 <td class="parameter_name"><p>retval</p></td>
 256 <td class="parameter_description"><p>value to be returned in case key is not found</p></td>
 257 <td class="parameter_annotations"> </td>
 258 </tr>
 259 </tbody>
 260 </table></div>
 261 </div>
 262 <div class="refsect3">
 263 <a name="id-1.2.3.7.3.6"></a><h4>Returns</h4>
 264 <p> the value corresponding to the key as an integer. If the key does
 265 not exist or cannot be converted to the integer, retval is returned.</p>
 266 <p></p>
 267 </div>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="tlm-config-set-int"></a><h3>tlm_config_set_int ()</h3>
 272 <pre class="programlisting"><span class="returnvalue">void</span>
 273 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>,
 274                     <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>,
 275                     <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>,
 276                     <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>
 277 <p>Sets the configuration value to the provided integer.</p>
 278 <div class="refsect3">
 279 <a name="id-1.2.3.7.4.5"></a><h4>Parameters</h4>
 280 <div class="informaltable"><table width="100%" border="0">
 281 <colgroup>
 282 <col width="150px" class="parameters_name">
 283 <col class="parameters_description">
 284 <col width="200px" class="parameters_annotations">
 285 </colgroup>
 286 <tbody>
 287 <tr>
 288 <td class="parameter_name"><p>self</p></td>
 289 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 290 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 291 </tr>
 292 <tr>
 293 <td class="parameter_name"><p>group</p></td>
 294 <td class="parameter_description"><p>the group name</p></td>
 295 <td class="parameter_annotations"> </td>
 296 </tr>
 297 <tr>
 298 <td class="parameter_name"><p>key</p></td>
 299 <td class="parameter_description"><p>the key name</p></td>
 300 <td class="parameter_annotations"> </td>
 301 </tr>
 302 <tr>
 303 <td class="parameter_name"><p>value</p></td>
 304 <td class="parameter_description"><p>the value</p></td>
 305 <td class="parameter_annotations"> </td>
 306 </tr>
 307 </tbody>
 308 </table></div>
 309 </div>
 310 </div>
 311 <hr>
 312 <div class="refsect2">
 313 <a name="tlm-config-get-uint"></a><h3>tlm_config_get_uint ()</h3>
 314 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
 315 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>,
 316                      <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>,
 317                      <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>,
 318                      <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>
 319 <p>Get an unsigned integer configuration value.</p>
 320 <div class="refsect3">
 321 <a name="id-1.2.3.7.5.5"></a><h4>Parameters</h4>
 322 <div class="informaltable"><table width="100%" border="0">
 323 <colgroup>
 324 <col width="150px" class="parameters_name">
 325 <col class="parameters_description">
 326 <col width="200px" class="parameters_annotations">
 327 </colgroup>
 328 <tbody>
 329 <tr>
 330 <td class="parameter_name"><p>self</p></td>
 331 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 332 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 333 </tr>
 334 <tr>
 335 <td class="parameter_name"><p>group</p></td>
 336 <td class="parameter_description"><p> the group name. </p></td>
 337 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 338 </tr>
 339 <tr>
 340 <td class="parameter_name"><p>key</p></td>
 341 <td class="parameter_description"><p> the key name. </p></td>
 342 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 343 </tr>
 344 <tr>
 345 <td class="parameter_name"><p>retval</p></td>
 346 <td class="parameter_description"><p>value to be returned in case key is not found</p></td>
 347 <td class="parameter_annotations"> </td>
 348 </tr>
 349 </tbody>
 350 </table></div>
 351 </div>
 352 <div class="refsect3">
 353 <a name="id-1.2.3.7.5.6"></a><h4>Returns</h4>
 354 <p> the value corresponding to the key as an unsigned integer. If the
 355 key does not exist or cannot be converted to the integer, retval is returned.</p>
 356 <p></p>
 357 </div>
 358 </div>
 359 <hr>
 360 <div class="refsect2">
 361 <a name="tlm-config-set-uint"></a><h3>tlm_config_set_uint ()</h3>
 362 <pre class="programlisting"><span class="returnvalue">void</span>
 363 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>,
 364                      <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>,
 365                      <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>,
 366                      <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>
 367 <p>Sets the configuration value to the provided unsigned integer.</p>
 368 <div class="refsect3">
 369 <a name="id-1.2.3.7.6.5"></a><h4>Parameters</h4>
 370 <div class="informaltable"><table width="100%" border="0">
 371 <colgroup>
 372 <col width="150px" class="parameters_name">
 373 <col class="parameters_description">
 374 <col width="200px" class="parameters_annotations">
 375 </colgroup>
 376 <tbody>
 377 <tr>
 378 <td class="parameter_name"><p>self</p></td>
 379 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 380 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 381 </tr>
 382 <tr>
 383 <td class="parameter_name"><p>group</p></td>
 384 <td class="parameter_description"><p>  the group name. </p></td>
 385 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 386 </tr>
 387 <tr>
 388 <td class="parameter_name"><p>key</p></td>
 389 <td class="parameter_description"><p>the key name</p></td>
 390 <td class="parameter_annotations"> </td>
 391 </tr>
 392 <tr>
 393 <td class="parameter_name"><p>value</p></td>
 394 <td class="parameter_description"><p>the value</p></td>
 395 <td class="parameter_annotations"> </td>
 396 </tr>
 397 </tbody>
 398 </table></div>
 399 </div>
 400 </div>
 401 <hr>
 402 <div class="refsect2">
 403 <a name="tlm-config-get-string"></a><h3>tlm_config_get_string ()</h3>
 404 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 405 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>,
 406                        <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>,
 407                        <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>
 408 <p>Get a string configuration value.</p>
 409 <div class="refsect3">
 410 <a name="id-1.2.3.7.7.5"></a><h4>Parameters</h4>
 411 <div class="informaltable"><table width="100%" border="0">
 412 <colgroup>
 413 <col width="150px" class="parameters_name">
 414 <col class="parameters_description">
 415 <col width="200px" class="parameters_annotations">
 416 </colgroup>
 417 <tbody>
 418 <tr>
 419 <td class="parameter_name"><p>self</p></td>
 420 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 421 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 422 </tr>
 423 <tr>
 424 <td class="parameter_name"><p>group</p></td>
 425 <td class="parameter_description"><p> the group name, NULL refers to General. </p></td>
 426 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 427 </tr>
 428 <tr>
 429 <td class="parameter_name"><p>key</p></td>
 430 <td class="parameter_description"><p> the key name. </p></td>
 431 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 432 </tr>
 433 </tbody>
 434 </table></div>
 435 </div>
 436 <div class="refsect3">
 437 <a name="id-1.2.3.7.7.6"></a><h4>Returns</h4>
 438 <p> the value corresponding to the key as an string. If the
 439 key does not exist, NULL is returned.</p>
 440 <p></p>
 441 </div>
 442 </div>
 443 <hr>
 444 <div class="refsect2">
 445 <a name="tlm-config-get-string-default"></a><h3>tlm_config_get_string_default ()</h3>
 446 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 447 tlm_config_get_string_default (<em class="parameter"><code><a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a> *self</code></em>,
 448                                <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>,
 449                                <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>,
 450                                <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>
 451 <p>Get a string configuration value.</p>
 452 <div class="refsect3">
 453 <a name="id-1.2.3.7.8.5"></a><h4>Parameters</h4>
 454 <div class="informaltable"><table width="100%" border="0">
 455 <colgroup>
 456 <col width="150px" class="parameters_name">
 457 <col class="parameters_description">
 458 <col width="200px" class="parameters_annotations">
 459 </colgroup>
 460 <tbody>
 461 <tr>
 462 <td class="parameter_name"><p>self</p></td>
 463 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 464 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 465 </tr>
 466 <tr>
 467 <td class="parameter_name"><p>group</p></td>
 468 <td class="parameter_description"><p> the group name, NULL refers to General. </p></td>
 469 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 470 </tr>
 471 <tr>
 472 <td class="parameter_name"><p>key</p></td>
 473 <td class="parameter_description"><p> the key name. </p></td>
 474 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 475 </tr>
 476 <tr>
 477 <td class="parameter_name"><p>value</p></td>
 478 <td class="parameter_description"><p> default value. </p></td>
 479 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 480 </tr>
 481 </tbody>
 482 </table></div>
 483 </div>
 484 <div class="refsect3">
 485 <a name="id-1.2.3.7.8.6"></a><h4>Returns</h4>
 486 <p> the value corresponding to the key as an string. If the
 487 key does not exist, given default value is returned.</p>
 488 <p></p>
 489 </div>
 490 </div>
 491 <hr>
 492 <div class="refsect2">
 493 <a name="tlm-config-set-string"></a><h3>tlm_config_set_string ()</h3>
 494 <pre class="programlisting"><span class="returnvalue">void</span>
 495 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>,
 496                        <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>,
 497                        <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>,
 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> *value</code></em>);</pre>
 499 <p>Sets the configuration value to the provided string.</p>
 500 <div class="refsect3">
 501 <a name="id-1.2.3.7.9.5"></a><h4>Parameters</h4>
 502 <div class="informaltable"><table width="100%" border="0">
 503 <colgroup>
 504 <col width="150px" class="parameters_name">
 505 <col class="parameters_description">
 506 <col width="200px" class="parameters_annotations">
 507 </colgroup>
 508 <tbody>
 509 <tr>
 510 <td class="parameter_name"><p>self</p></td>
 511 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 512 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 513 </tr>
 514 <tr>
 515 <td class="parameter_name"><p>group</p></td>
 516 <td class="parameter_description"><p> the group name. </p></td>
 517 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 518 </tr>
 519 <tr>
 520 <td class="parameter_name"><p>key</p></td>
 521 <td class="parameter_description"><p> the key name. </p></td>
 522 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 523 </tr>
 524 <tr>
 525 <td class="parameter_name"><p>value</p></td>
 526 <td class="parameter_description"><p> the value. </p></td>
 527 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 528 </tr>
 529 </tbody>
 530 </table></div>
 531 </div>
 532 </div>
 533 <hr>
 534 <div class="refsect2">
 535 <a name="tlm-config-get-boolean"></a><h3>tlm_config_get_boolean ()</h3>
 536 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 537 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>,
 538                         <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>,
 539                         <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>,
 540                         <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>
 541 <p>Get a boolean configuration value.</p>
 542 <div class="refsect3">
 543 <a name="id-1.2.3.7.10.5"></a><h4>Parameters</h4>
 544 <div class="informaltable"><table width="100%" border="0">
 545 <colgroup>
 546 <col width="150px" class="parameters_name">
 547 <col class="parameters_description">
 548 <col width="200px" class="parameters_annotations">
 549 </colgroup>
 550 <tbody>
 551 <tr>
 552 <td class="parameter_name"><p>self</p></td>
 553 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 554 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 555 </tr>
 556 <tr>
 557 <td class="parameter_name"><p>group</p></td>
 558 <td class="parameter_description"><p> the group name. </p></td>
 559 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 560 </tr>
 561 <tr>
 562 <td class="parameter_name"><p>key</p></td>
 563 <td class="parameter_description"><p> the key name. </p></td>
 564 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 565 </tr>
 566 <tr>
 567 <td class="parameter_name"><p>retval</p></td>
 568 <td class="parameter_description"><p>value to be returned in case key is not found</p></td>
 569 <td class="parameter_annotations"> </td>
 570 </tr>
 571 </tbody>
 572 </table></div>
 573 </div>
 574 <div class="refsect3">
 575 <a name="id-1.2.3.7.10.6"></a><h4>Returns</h4>
 576 <p> the value corresponding to the key as boolean. If the
 577 key does not exist or cannot be converted to boolean, retval is returned.</p>
 578 <p></p>
 579 </div>
 580 </div>
 581 <hr>
 582 <div class="refsect2">
 583 <a name="tlm-config-set-boolean"></a><h3>tlm_config_set_boolean ()</h3>
 584 <pre class="programlisting"><span class="returnvalue">void</span>
 585 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>,
 586                         <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>,
 587                         <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>,
 588                         <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>
 589 <p>Sets the configuration value to the provided <span class="type">value</span>.</p>
 590 <div class="refsect3">
 591 <a name="id-1.2.3.7.11.5"></a><h4>Parameters</h4>
 592 <div class="informaltable"><table width="100%" border="0">
 593 <colgroup>
 594 <col width="150px" class="parameters_name">
 595 <col class="parameters_description">
 596 <col width="200px" class="parameters_annotations">
 597 </colgroup>
 598 <tbody>
 599 <tr>
 600 <td class="parameter_name"><p>self</p></td>
 601 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 602 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 603 </tr>
 604 <tr>
 605 <td class="parameter_name"><p>group</p></td>
 606 <td class="parameter_description"><p>the group name</p></td>
 607 <td class="parameter_annotations"> </td>
 608 </tr>
 609 <tr>
 610 <td class="parameter_name"><p>key</p></td>
 611 <td class="parameter_description"><p>the key name</p></td>
 612 <td class="parameter_annotations"> </td>
 613 </tr>
 614 <tr>
 615 <td class="parameter_name"><p>value</p></td>
 616 <td class="parameter_description"><p>the value</p></td>
 617 <td class="parameter_annotations"> </td>
 618 </tr>
 619 </tbody>
 620 </table></div>
 621 </div>
 622 </div>
 623 <hr>
 624 <div class="refsect2">
 625 <a name="tlm-config-has-group"></a><h3>tlm_config_has_group ()</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>
 627 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>,
 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> *group</code></em>);</pre>
 629 <p>Checks if any configuration available for <span class="type">group</span>.</p>
 630 <div class="refsect3">
 631 <a name="id-1.2.3.7.12.5"></a><h4>Parameters</h4>
 632 <div class="informaltable"><table width="100%" border="0">
 633 <colgroup>
 634 <col width="150px" class="parameters_name">
 635 <col class="parameters_description">
 636 <col width="200px" class="parameters_annotations">
 637 </colgroup>
 638 <tbody>
 639 <tr>
 640 <td class="parameter_name"><p>self</p></td>
 641 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 642 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 643 </tr>
 644 <tr>
 645 <td class="parameter_name"><p>group</p></td>
 646 <td class="parameter_description"><p>the group name</p></td>
 647 <td class="parameter_annotations"> </td>
 648 </tr>
 649 </tbody>
 650 </table></div>
 651 </div>
 652 <div class="refsect3">
 653 <a name="id-1.2.3.7.12.6"></a><h4>Returns</h4>
 654 <p> TRUE if found, FALSE otherwise.</p>
 655 <p></p>
 656 </div>
 657 </div>
 658 <hr>
 659 <div class="refsect2">
 660 <a name="tlm-config-has-key"></a><h3>tlm_config_has_key ()</h3>
 661 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 662 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>,
 663                     <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>,
 664                     <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>
 665 <p>Checks if <span class="type">key</span> is in given <span class="type">group</span>.</p>
 666 <div class="refsect3">
 667 <a name="id-1.2.3.7.13.5"></a><h4>Parameters</h4>
 668 <div class="informaltable"><table width="100%" border="0">
 669 <colgroup>
 670 <col width="150px" class="parameters_name">
 671 <col class="parameters_description">
 672 <col width="200px" class="parameters_annotations">
 673 </colgroup>
 674 <tbody>
 675 <tr>
 676 <td class="parameter_name"><p>self</p></td>
 677 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 678 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 679 </tr>
 680 <tr>
 681 <td class="parameter_name"><p>group</p></td>
 682 <td class="parameter_description"><p>the group name</p></td>
 683 <td class="parameter_annotations"> </td>
 684 </tr>
 685 <tr>
 686 <td class="parameter_name"><p>key</p></td>
 687 <td class="parameter_description"><p>the key name</p></td>
 688 <td class="parameter_annotations"> </td>
 689 </tr>
 690 </tbody>
 691 </table></div>
 692 </div>
 693 <div class="refsect3">
 694 <a name="id-1.2.3.7.13.6"></a><h4>Returns</h4>
 695 <p> TRUE, if found, FALSE otherwise.</p>
 696 <p></p>
 697 </div>
 698 </div>
 699 <hr>
 700 <div class="refsect2">
 701 <a name="tlm-config-get-group"></a><h3>tlm_config_get_group ()</h3>
 702 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *
 703 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>,
 704                       <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>
 705 <p>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></p>
 706 <div class="refsect3">
 707 <a name="id-1.2.3.7.14.5"></a><h4>Parameters</h4>
 708 <div class="informaltable"><table width="100%" border="0">
 709 <colgroup>
 710 <col width="150px" class="parameters_name">
 711 <col class="parameters_description">
 712 <col width="200px" class="parameters_annotations">
 713 </colgroup>
 714 <tbody>
 715 <tr>
 716 <td class="parameter_name"><p>self</p></td>
 717 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 718 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 719 </tr>
 720 <tr>
 721 <td class="parameter_name"><p>group</p></td>
 722 <td class="parameter_description"><p>the group name</p></td>
 723 <td class="parameter_annotations"> </td>
 724 </tr>
 725 </tbody>
 726 </table></div>
 727 </div>
 728 <div class="refsect3">
 729 <a name="id-1.2.3.7.14.6"></a><h4>Returns</h4>
 730 <p> the key, value paired dictionary if found,
 731 NULL otherwise. </p>
 732 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 733 </div>
 734 </div>
 735 <hr>
 736 <div class="refsect2">
 737 <a name="tlm-config-reload"></a><h3>tlm_config_reload ()</h3>
 738 <pre class="programlisting"><span class="returnvalue">void</span>
 739 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>
 740 <p>Reloads the configuration.</p>
 741 <div class="refsect3">
 742 <a name="id-1.2.3.7.15.5"></a><h4>Parameters</h4>
 743 <div class="informaltable"><table width="100%" border="0">
 744 <colgroup>
 745 <col width="150px" class="parameters_name">
 746 <col class="parameters_description">
 747 <col width="200px" class="parameters_annotations">
 748 </colgroup>
 749 <tbody><tr>
 750 <td class="parameter_name"><p>self</p></td>
 751 <td class="parameter_description"><p> an instance of <a class="link" href="TlmConfig.html" title="TlmConfig"><span class="type">TlmConfig</span></a>. </p></td>
 752 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 753 </tr></tbody>
 754 </table></div>
 755 </div>
 756 </div>
 757 </div>
 758 <div class="refsect1">
 759 <a name="TlmConfig.other_details"></a><h2>Types and Values</h2>
 760 </div>
 761 </div>
 762 <div class="footer">
 763 <hr>
 764           Generated by GTK-Doc V1.20</div>
 765 </body>
 766 </html>