4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GConfEngine</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="GConf Reference Manual">
8
8
<link rel="up" href="ch01.html" title="Using the GConf library">
9
9
<link rel="prev" href="gconf-gconf-backend.html" title="gconf-backend">
39
39
<a name="gconf-gconf-engine.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis"> <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine">GConfEngine</a>;
41
41
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-default" title="gconf_engine_get_default ()">gconf_engine_get_default</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
42
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-address" title="gconf_engine_get_for_address ()">gconf_engine_get_for_address</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
43
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
44
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-addresses" title="gconf_engine_get_for_addresses ()">gconf_engine_get_for_addresses</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
45
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
42
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-address" title="gconf_engine_get_for_address ()">gconf_engine_get_for_address</a> (<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> *address</code></em>,
43
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
44
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-addresses" title="gconf_engine_get_for_addresses ()">gconf_engine_get_for_addresses</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
45
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
46
46
<span class="returnvalue">void</span> <a class="link" href="gconf-gconf-engine.html#gconf-engine-unref" title="gconf_engine_unref ()">gconf_engine_unref</a> (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *conf</code></em>);
47
47
<span class="returnvalue">void</span> <a class="link" href="gconf-gconf-engine.html#gconf-engine-ref" title="gconf_engine_ref ()">gconf_engine_ref</a> (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *conf</code></em>);
48
48
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> * <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-local" title="gconf_engine_get_local ()">gconf_engine_get_local</a> (<em class="parameter"><code>const <span class="type">char</span> *address</code></em>,
49
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
49
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
50
50
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> * <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-local-for-addresses" title="gconf_engine_get_local_for_addresses ()">gconf_engine_get_local_for_addresses</a>
51
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
52
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
51
(<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
52
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
53
53
<span class="returnvalue">void</span> <a class="link" href="gconf-gconf-engine.html#gconf-engine-set-user-data" title="gconf_engine_set_user_data ()">gconf_engine_set_user_data</a> (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>,
54
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
55
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);
56
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-user-data" title="gconf_engine_get_user_data ()">gconf_engine_get_user_data</a> (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);
54
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
55
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);
56
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-user-data" title="gconf_engine_get_user_data ()">gconf_engine_get_user_data</a> (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);
59
59
<div class="refsect1" title="Description">
85
85
<a name="gconf-engine-get-default"></a><h3>gconf_engine_get_default ()</h3>
86
86
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* gconf_engine_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
88
Returns the default <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>. All clients should use this, unless
88
Returns the default <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>. All clients should use this, unless
89
89
they are special configuration-related tools. The caller of this
90
90
function assumes one reference count, and must call
91
91
<a class="link" href="gconf-gconf-engine.html#gconf-engine-unref" title="gconf_engine_unref ()"><code class="function">gconf_engine_unref()</code></a> at some point. It's fairly important to unref the
92
92
<a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>, to cleanly close the connection to
93
93
<span class="application">gconfd</span>. So if possible close the connection
94
before exiting your application. see ? <code class="function">printf()</code> <code class="function"><code class="function">printf()</code></code>
94
before exiting your application.
96
96
<div class="variablelist"><table border="0">
97
97
<col align="left" valign="top">
99
99
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
100
<td>the default <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>.
100
<td> the default <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
106
106
<div class="refsect2" title="gconf_engine_get_for_address ()">
107
107
<a name="gconf-engine-get-for-address"></a><h3>gconf_engine_get_for_address ()</h3>
108
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* gconf_engine_get_for_address (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
109
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
108
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* gconf_engine_get_for_address (<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> *address</code></em>,
109
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
111
111
Obtains a special <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>; mostly useful for specialized
112
112
GConf-related tools. Normal clients shouldn't need to use it.
138
138
<div class="refsect2" title="gconf_engine_get_for_addresses ()">
139
139
<a name="gconf-engine-get-for-addresses"></a><h3>gconf_engine_get_for_addresses ()</h3>
140
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* gconf_engine_get_for_addresses (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
141
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
140
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a>* gconf_engine_get_for_addresses (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
141
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
143
143
Similar to <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-for-address" title="gconf_engine_get_for_address ()"><code class="function">gconf_engine_get_for_address()</code></a> , but takes a list of addresses
144
144
instead of a single address.
202
202
<div class="refsect2" title="gconf_engine_get_local ()">
203
203
<a name="gconf-engine-get-local"></a><h3>gconf_engine_get_local ()</h3>
204
204
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> * gconf_engine_get_local (<em class="parameter"><code>const <span class="type">char</span> *address</code></em>,
205
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
205
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
207
207
Obtain a local (non-process-transparent) <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>. Local engines
208
208
do not support notification, and can only access config databases
234
234
<div class="refsect2" title="gconf_engine_get_local_for_addresses ()">
235
235
<a name="gconf-engine-get-local-for-addresses"></a><h3>gconf_engine_get_local_for_addresses ()</h3>
236
236
<pre class="programlisting"><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="returnvalue">GConfEngine</span></a> * gconf_engine_get_local_for_addresses
237
(<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
238
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
237
(<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *addresses</code></em>,
238
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
240
240
Obtains a local <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> similar to <a class="link" href="gconf-gconf-engine.html#gconf-engine-get-local" title="gconf_engine_get_local ()"><code class="function">gconf_engine_get_local()</code></a>.
241
241
Instead of taking the address of the local database, this function takes
267
267
<div class="refsect2" title="gconf_engine_set_user_data ()">
268
268
<a name="gconf-engine-set-user-data"></a><h3>gconf_engine_set_user_data ()</h3>
269
269
<pre class="programlisting"><span class="returnvalue">void</span> gconf_engine_set_user_data (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>,
270
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
271
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);</pre>
270
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
271
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> dnotify</code></em>);</pre>
273
273
Sets the user_data and the destroy notification function fields of a <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>.
297
297
<div class="refsect2" title="gconf_engine_get_user_data ()">
298
298
<a name="gconf-engine-get-user-data"></a><h3>gconf_engine_get_user_data ()</h3>
299
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> gconf_engine_get_user_data (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);</pre>
299
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> gconf_engine_get_user_data (<em class="parameter"><code><a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a> *engine</code></em>);</pre>
301
301
Returns the user_data field of a <a class="link" href="gconf-gconf-engine.html#GConfEngine" title="GConfEngine"><span class="type">GConfEngine</span></a>.